(FM-7878) Update transport docs #139
Conversation
There were some inaccuracies vs the actual implementation and some copy editing to make the document flow better.
This commit makes minor grammatical edits.
language/resource-api/README.md
Outdated
| ### Legacy Support | ||
|
|
||
| Before Puppet 6.X (TBD), remote resources were only supported through the `Puppet::Util::NetworkDevice` namespace. To make a module useful on these older versions, a shim `Device` class needs to be provided to connect the dots: | ||
| Before the Resource API, remote resources were only supported through the `Puppet::Util::NetworkDevice` namespace. To connect your transport to what Puppet expects, you need to provide a shim `Device` class. |
There was a problem hiding this comment.
Maybe change: "To connect your transport to what Puppet expects, you need to provide a shim Device class."
To: "To connect your transport in a way that Puppet understands, you need to provide a shim Device class."
If this is what it means? If not please clarify.
There was a problem hiding this comment.
That sounds so much better.
language/resource-api/README.md
Outdated
| Inheriting from `Puppet::ResourceApi::Transport::Wrapper` will ensure that the necessary `Device` methods will be implemented using your transport. | ||
| Inheriting from `Puppet::ResourceApi::Transport::Wrapper` ensures that the necessary `Device` methods are implemented using your transport. Specify the transport name in the `super` call to make the connection. | ||
| > Note that because of the way the Resource API is bundled with Puppet agent packages, agent versions 6.0 through 6.3 are incompatible with this way of executing remote content. These versions will not be supported after [PE 2019.0 in August 2019](https://puppet.com/misc/puppet-enterprise-lifecycle). |
There was a problem hiding this comment.
2019.0 has been out for a while? This sounds like it comes out in August 2019.
There was a problem hiding this comment.
changed to These versions will not be supported after [support for PE 2019.0 ends in August 2019](https://puppet.com/misc/puppet-enterprise-lifecycle). for clarity
|
@clairecadman fixed the last two issues. Please merge if you're satisfied. |
3 participants
There were some inaccuracies vs the actual implementation and some copy
editing to make the document flow better.