(CAT-1345) Update gem README.md #61
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
david22swan
force-pushed
the
cat-1345/main/update_readme
branch
2 times, most recently
from
1838a47 to
84c873d
Compare
david22swan
changed the title
README is barebones and contains little information. Updating to include more detailed instructions and what it is and how to use it.
david22swan
force-pushed
the
cat-1345/main/update_readme
branch
from
84c873d to
735f27e
Compare
ekohl
reviewed
Sep 18, 2023
Contributor
ekohl
left a comment
ekohl
left a comment
There was a problem hiding this comment.
I like the expansion. Bit late, but please consider my suggestions for a follow up.
| ## Development | ||
| For conveniances sake the `puppet-modulebuilder` gem has been included within the `PDK` and as such can be called on to run against a module from within it using the build command as shown below: | ||
|
|
||
| ```ruby |
|
|
||
| The purpose of this tool is to take a given local module directory and compile it into a `.tar` file, known as the `tarball`, that can then be installed directly by Puppet on a target machine or uploaded onto the [Puppet Forge](https://forge.puppet.com/) so that it can be accessed publicly. | ||
|
|
||
| As part of this process any non-deliverable aspects of the module, parts of it related to the modules development or testing for example, are stripped away leaving only the documentation and the puppet/ruby code that is needed for the module to function. |
Contributor
There was a problem hiding this comment.
Should it describe which files it reads here? Like .gitignore, .pmtignore, .pdkignore and in which order?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README is barebones and contains little information. Updating to include more detailed instructions and what it is and how to use it.
Checklist