README.md in pdk-1.2.0 vs README.md in pdk-1.2.1
- old
+ new
@@ -3,10 +3,11 @@
* [Installation](#installation)
* [Basic usage](#basic-usage)
* [Experimental features](#experimental-features)
* [Module compatibility](#module-compatibility)
* [Contributing](#contributing)
+* [Contact Information](#contact-information)
The Puppet Development Kit (PDK) includes key Puppet code development and testing tools for Linux, Windows, and OS X workstations, so you can install one package with the tools you need to create and validate new modules.
PDK includes testing tools, a complete module skeleton, and command line tools to help you create, validate, and run tests on Puppet modules. PDK also includes all dependencies needed for its use.
@@ -25,15 +26,15 @@
## Installation
Download and install the newest package matching your platform from the [download](https://puppet.com/download-puppet-development-kit) page. If you are using Windows, remember to close any open PowerShell windows.
-For complete installation information, see the [PDK documentation](https://docs.puppet.com/pdk/latest/pdk_install.html).
+For complete installation information, see the [PDK documentation](https://puppet.com/docs/pdk/latest/pdk_install.html).
## Basic usage
-PDK can generate modules and classes, validate module metadata, style, and syntax, and run unit tests. This README contains very basic usage information---for complete usage information, see the [PDK documentation](https://docs.puppet.com/pdk/).
+PDK can generate modules and classes, validate module metadata, style, and syntax, and run unit tests. This README contains very basic usage information---for complete usage information, see the [PDK documentation](https://puppet.com/docs/pdk/latest/pdk_install.html).
### Generate a module
Generates the basic components of a module and set up an infrastructure for testing it with PDK.
@@ -127,20 +128,19 @@
[...]
```
#### Known issues
-* `pdk bundle` command on Windows doesn't allow usage suggested by pdk help [PDK-408](https://tickets.puppetlabs.com/browse/PDK-408)
-On Windows, the `pdk bundle` command doesn't allow `--` as a separator between pdk option flags and bundler option flags as suggested by `pdk help bundle`.
+Note that for PowerShell the `--` must be escaped using a backtick ( <code>`-- </code> ) or the shell parses it and strips it out of the command. See [PDK-408](https://tickets.puppet.com/browse/PDK-408) for details.
-The issue is that PDK is consuming command line options meant for the subcommand. To work around this, run `pdk bundle exec` with a string specifying the command you want to run with its command line options.
-
-For example: `pdk bundle exec "bundle install --binstubs"`
-
## Module Compatibility
**PDK Version Compatibility:** Modules created with PDK version validate against and run on all Puppet and Ruby version combinations currently under maintenance (see https://docs.puppet.com/puppet/latest/about_agent.html and https://puppet.com/misc/puppet-enterprise-lifecycle)
## Contributing
PDK encourages community contributions. See the [CONTRIBUTING.md](CONTRIBUTING.md) file for development notes.
+
+## Contact Information
+
+To contact us with questions: [pdk-maintainers@puppet.com](mailto:pdk-maintainers@puppet.com)