Updating the documentation style guide #1342
Merged
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
Removing style guide from tech docs to put it in contributing docs
Updates to the style guide
Merged
|
@manez does this need a line in |
|
@whikloj Indeed it does. I moved it to the new section in |
whikloj
reviewed
Nov 19, 2019
mkdocs.yml
Outdated
| @@ -77,4 +76,5 @@ pages: | |||
| - 'Islandora 7': 'technical-documentation/migrate-7x.md' | |||
| - Contributing: | |||
| - 'How to contribute': 'contributing/CONTRIBUTING.md' | |||
| - 'Documentation Style Guide': 'technical-documentation/docs_style_guide.md' | |||
There was a problem hiding this comment.
path needs to be 'contributing/docs_style_guide.md'
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.
GitHub Issue: #1040
What does this Pull Request do?
Moves the documentation style guide from the technical documentation section to the contributing section (I think it makes more sense there), and adds some guidelines, mostly based on the guidelines we documented for the current sprint.
What's new?
Deleted the old page, put it in a new spot, added some items.
How should this be tested?
Preview the document, see if it makes sense/is helpful as a guide for documentation contributors.
Interested parties
@Islandora/8-x-committers and @ysuarez