Skip to content

Commit

Permalink
Merge pull request #1285 from puppetlabs/CAT-435/main/update_urls
Browse files Browse the repository at this point in the history
(CAT-345) Update doc links where needed
  • Loading branch information
LukasAud authored Nov 8, 2023
2 parents 4e46ce2 + ee7a430 commit cb82724
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 15 deletions.
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [rspec-puppet](https://github.com/puppetlabs/rspec-puppet/) for catalog-level unit testing.

In the module's directory, run unit tests with:

Expand Down
2 changes: 1 addition & 1 deletion docs/pdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ validate, and test modules.
<ul>
<li><a class="xref" href="https://github.com/puppetlabs/puppet-lint" target="_blank">puppet-lint</a>, included in PDK, validates Puppet code against the recommended language style guide.</li>
<li><a class="xref" href="https://github.com/voxpupuli/metadata-json-lint" target="_blank">metadata-json-lint</a>, included in PDK, validates your module metadata file.</li>
<li><a class="xref" href="http://rspec-puppet.com/" target="_blank">rspec-puppet</a>, included in PDK, provides an RSpec test framework for Puppet.</li>
<li><a class="xref" href="http://rspec-puppet.com/" target="_blank">puppetlabs-rspec</a>, included in PDK, provides an RSpec test framework for Puppet.</li>
<li><a class="xref" href="https://github.com/voxpupuli/rspec-puppet-facts" target="_blank">rspec-puppet-facts</a>, included in PDK, provides support for running rspec tests for your module's supported operating systems.</li>
<li><a class="xref" href="https://rubocop.org/" target="_blank">Rubocop</a>, a Ruby code analyzer.</li>
<li><a class="xref" href="https://www.youtube.com/watch?v=GgNrxLfoDF8" target="_blank">Introduction to testing Puppet code</a>: a talk by David Schmitt.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/pdk_building_module_packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The `pdk build` command performs a series of checks on your module and builds a
`tar.gz` package so that you can upload your module to the Forge. To learn more
about publishing your module to the Forge, see the documentation about
[publishing your
module](https://www.puppet.com/docs/puppet/latest/modules_publishing.html#modules_publishing_prep-publishing-remove-symlinks)
module](https://www.puppet.com/docs/puppet/latest/modules_publishing.html).

When you run the `pdk build` command, PDK checks your module metadata, looks for
any symlinks, and excludes from the package any files listed in the `.gitignore`
Expand Down
2 changes: 1 addition & 1 deletion docs/pdk_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ By default, PDK installs to the following locations:

PDK uses the latest versions of Puppet 7 and 8 available at the time of release.
Modules created with PDK work with all Puppet and Ruby version combinations currently under maintenance.
See [open source Puppet](https://puppet.com/docs/puppet/latest/about_agent.html) and
See the [open source Puppet](https://puppet.com/docs/puppet/latest/about_agent.html) and
[Puppet Enterprise](https://www.puppet.com/docs/pe/2023.0/getting_support_for_pe.html#getting_support_for_pe) lifecycle pages for details.

PDK functions, such as creating classes, testing, and validation, are supported only on modules created or converted with PDK.
Expand Down
4 changes: 2 additions & 2 deletions docs/pdk_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ topic.
|--------|-----------|------|-------|
|`<module_name>`|Required. Specifies the name of the module being created.|A module name beginning with a lowercase letter and including only lowercase letters, digits, and underscores.|No default.|
|`--full-interview`|Include interview questions related to publishing modules on the Forge to create module metadata.|None.|If not specified, PDK asks only basic module metadata questions. |
|`--license=<IDENTIFIER>`|Specifies the license for this module is written under.|See the [SPDX](https://spdx.org) License List for a list of open source licenses, or use `proprietary`.|`Apache-2.0`|
|`--license=<IDENTIFIER>`|Specifies the license for this module is written under.|See the [SPDX](https://spdx.org/licenses/) License List for a list of open source licenses, or use `proprietary`.|`Apache-2.0`|
|`--skip-interview`|Skip interview questions and use default values to create module metadata.|None.|If not specified, PDK asks basic module metadata questions.|
|`<TARGET_DIR>`|Specifies the directory that the new module will be created in.|A valid directory path.|Creates a directory with the given `module_name` inside the current directory.|
|`--template-ref=<VALUE>`|Specifies the reference to use for the specified template for this module. This option is valid only if you have specified a template with the `--template-url` option.|A template branch name, tag name, or commit SHA for the specified template.|If you have specified a custom template, or if you installed PDK as a gem, this option defaults to "main". Otherwise, defaults to the defaults to the currently installed PDK version.|
Expand Down Expand Up @@ -420,7 +420,7 @@ topic.
|`--puppet-dev`|When specified, PDK runs unit tests against the current Puppet source from GitHub. To use this option, you must have network access to https://github.com. You cannot specify `--puppet-dev` together with the `--puppet-version=` options.|None.|If not specified, PDK runs unit tests against default values or those specified by `--puppet-version`.|
|`--puppet-version`|Specifies the Puppet gem version to run unit tests against.|A string indicating the Puppet version to test against, such as "5.4.2" or "5.5".|If not specified, tests against the most recent compatible Puppet version included in the PDK package.|
|`--tests=<TEST_LIST>`|A comma-separated list of tests to run. Use this during development to pinpoint a single failing test.|See the `--list` output for available values.|No default.|
|`--verbose`|When specified, PDK outputs a single line description for each test as the test is executed. This option uses the RSpec `documentation` format. For more information, see [RSpec Core 2.5](https://relishapp.com/rspec/rspec-core/v/2-5/docs/command-line/format-option#documentation-format).|None.|None.|
|`--verbose`|When specified, PDK outputs a single line description for each test as the test is executed. This option uses the RSpec `documentation` format. For more information, see [RSpec Core Formatters](https://rubydoc.info/gems/rspec-core/RSpec/Core/Formatters).|None.|None.|
## `pdk update` command
Expand Down
8 changes: 4 additions & 4 deletions docs/pdk_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ By default, the PDK module template includes tools that can:


If you are working behind a proxy, before you begin, ensure that you've added
the correct environment variables. See [Running PDK behind a
proxy](pdk_install.md#running-pdk-behind-a-proxy) for details.
the correct environment variables. See [Setting up PDK behind a
proxy](pdk_install.md#setting-up-pdk-behind-a-proxy) for details.

To ensure that your module works with Puppet, validate and unit test your
modules against specific versions of Puppet and Puppet Enterprise. This allows
Expand All @@ -33,7 +33,7 @@ examples, see the unit testing and validation topics below.
You can validate or test against any version of Puppet or PE that is currently
under maintenance. See [open source
Puppet](https://docs.puppet.com/puppet/latest/about_agent.html) and [Puppet
Enterprise](https://puppet.com/docs/pe/2017.3/overview/getting_support_for_pe.html#supported-puppet-enterprise-versions)
Enterprise](https://www.puppet.com/products/puppet-enterprise/support-lifecycle)
lifecycle pages for details.

## Validating modules
Expand Down Expand Up @@ -176,7 +176,7 @@ For more information about RSpec and writing unit tests, see:

- [RSpec](http://rspec.info/)

- [rspec-puppet](https://github.com/rodjek/rspec-puppet/)
- [rspec-puppet](https://github.com/puppetlabs/rspec-puppet/)

- [Puppet spec helper](https://github.com/puppetlabs/puppetlabs_spec_helper)

Expand Down

0 comments on commit cb82724

Please sign in to comment.