Created README content, updated extension and deleted extraneous READMEs #1
Conversation
This file contains 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
… extraneous READMEs, and added markdown extension Before alterations, this module contained no README. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I created content through testing and deploying the module in a test environment and documenting the steps. Standard headings were added (Overview, Module Description, Setup, Usage, etc.) to organize content, and basic formatting was done to adhere to template standards. File extension .md was added to enable Markdown formatting in GitHub. As this module was built with the pre-faces version of the module tool, READMEs explaining each folder's purpose were still present. Deleted those for consistency and to help the module get with the times.
ryanycoleman
pushed a commit
that referenced
this pull request
Jan 29, 2013
Created README content, updated extension and deleted extraneous READMEs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before alterations, this module contained no primary README.
As part of a joint Forge/Docs team effort to standardize formatting and
encourage quality module documentation, a best practices README
template was created via internal and external user testing. That
template was then applied to this module.
I created content through testing and deploying the module in a test
environment and documenting the steps. Standard headings were added
(Overview, Module Description, Setup, Usage, etc.) to organize content,
and basic formatting was done to adhere to template standards. File
extension .md was added to enable Markdown formatting in GitHub. As
this module was built with the pre-faces version of the module tool,
READMEs explaining each folder's purpose were still present. Deleted
those for consistency and to help the module get with the times.