From 004c1e1982c8bfcc15660350d733a61973d9678e Mon Sep 17 00:00:00 2001 From: david22swan Date: Wed, 25 Oct 2023 14:10:25 +0100 Subject: [PATCH 1/3] (CAT-435) Update README.md and CONTRIBUTING.md Update guides to remove broken or out of date URLs. Also includes update to reflect current practices --- CONTRIBUTING.md | 13 ++++++++----- README.md | 2 +- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c541b6e1..9f8b2f68a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,18 +3,21 @@ ## Reporting Bugs We welcome error reports and patches to the PDK repository. -If you have discovered an issue, please raise it here: https://github.com/puppetlabs/pdk/issues -PRs to resolve issues discovered are greatly appreciated - please start a Discussion [here](https://github.com/puppetlabs/pdk/discussions) or post a question to [puppet-users@groups.google.com](https://groups.google.com/forum/#!forum/puppet-users). +If you have discovered an issue, you can raise it [here](https://github.com/puppetlabs/pdk/issues) or reach out to us directly on the [Puppet Community Slack](https://slack.puppet.com/). + +In addition if there is something that you do not understand, or a point that you wish to clarify you can start a Discussion [here](https://github.com/puppetlabs/pdk/discussions) or post a question to [puppet-users@groups.google.com](https://groups.google.com/forum/#!forum/puppet-users). + +Finally if you have a fix for an issue you can open a PR to resolve it [here](https://github.com/puppetlabs/pdk/pulls). ## Raising Feature Requests Feature requests are also welcome. To raise a request, please start a ['Feature Request' Discussion](https://github.com/puppetlabs/pdk/discussions/categories/feature-request). -After there is consensus on how to proceed, a Discussion will be converted in to a Feature Issue and prioritized, accordingly. +Once there is consensus on how to proceed, we can then create a ticket for our backlog and plan for bringing it in to a future sprint. # Running from source -If you need to run `pdk` in a working directory outside the cloned repository, either set `BUNDLE_GEMFILE` to the pdk's Gemfile location, or install and use the [binstubs of bundler](http://bundler.io/v1.15/bundle_binstubs.html). These binstubs are small proxy binaries that set up the environment for running the tool. +If you need to run `pdk` in a working directory outside the cloned repository, either set `BUNDLE_GEMFILE` to the pdk's Gemfile location, or install and use the [binstubs of bundler](http://bundler.io/bundle_binstubs.html). These binstubs are small proxy binaries that set up the environment for running the tool. ``` # assuming ~/bin is already on your path: @@ -70,7 +73,7 @@ Environment Variable | Usage *--or--* | **LOCAL_PKG** | Full path to a locally built package that you want to test. **TEST_TARGET** | A beaker-hostgenerator string for the OS of the VM you want to test on e.g. _redhat7-64workstation._ or _windows2012r2-64workstation._ (The period character after workstation is required by beaker-hostgenerator). -**BUILD_SERVER** | (Defaults to 'builds.delivery.puppetlabs.net' if not set) (Only required if testing a SHA on a Windows VM). The hostname of the build server that hosts packages. A Puppet JIRA ticket ([BKR-1109](https://tickets.puppetlabs.com/browse/BKR-1109)) has been filed to update beaker so this would never be required. +**BUILD_SERVER** | (Defaults to 'builds.delivery.puppetlabs.net' if not set) (Only required if testing a SHA on a Windows VM). The hostname of the build server that hosts packages. **SUITE_VERSION** | (If not set, will be automatically determined if possible) The build tag/version string used when installing packages on certain platforms - e.g. if the package you built is `pdk-0.5.0.0.21.gb84d40e-1.osx10.12.dmg` then **SUITE_VERSION** would be `0.5.0.0.21.gb84d40e` # Release Process diff --git a/README.md b/README.md index a603e540b..0014a1111 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ This command validates the metadata, Puppet code syntax and style, and Ruby synt ### Run unit tests -PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing. +PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [puppetlabs-rspec](https://github.com/puppetlabs/puppetlabs-rspec/) for catalog-level unit testing. In the module's directory, run unit tests with: From 16f258cd37efc4fd54b741061b39b97cdbf9c7c8 Mon Sep 17 00:00:00 2001 From: david22swan Date: Thu, 26 Oct 2023 13:35:55 +0100 Subject: [PATCH 2/3] (CAT-345) Update doc links where needed --- docs/pdk.md | 2 +- docs/pdk_building_module_packages.md | 2 +- docs/pdk_install.md | 2 +- docs/pdk_reference.md | 4 ++-- docs/pdk_testing.md | 10 +++++----- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/pdk.md b/docs/pdk.md index 040ed3f1a..60ce4d1eb 100644 --- a/docs/pdk.md +++ b/docs/pdk.md @@ -62,7 +62,7 @@ validate, and test modules.