-
Notifications
You must be signed in to change notification settings - Fork 8k
Addition of a 'Contribute' section with our Style Guide #15350
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
642554a
SG test.
aevesdocker ae8aad6
moved some content around
aevesdocker b08f4d8
editing
aevesdocker 0843784
broken links fix
aevesdocker 511bb5e
formatting changes
aevesdocker c2cf1b4
fixes
aevesdocker c4c1093
fixes
aevesdocker 801559f
edits after review
aevesdocker 82e271b
fix broken links
aevesdocker 611a848
broken link fix
aevesdocker a5534b3
a few more edits
aevesdocker 5822cd5
removed contributing page
aevesdocker b7d5c8d
Revert "removed contributing page"
aevesdocker a6b6c08
add redirect
aevesdocker 6610966
Merge branch 'master' into SG-test
aevesdocker File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: Writing checklist | ||
| description: A helpful writing checklist when creating documentation | ||
| keywords: checklist, documentation, style guide, contribute | ||
| --- | ||
|
|
||
| Use this checklist to communicate in a way that is clear, helpful, and consistent with the rest of Docker Docs. | ||
|
|
||
| ##### Used active voice | ||
|
|
||
| Active voice is specific and removes ambiguity. | ||
|
|
||
| In active voice, the subject of the sentence (the customer or the system) does the action. | ||
|
|
||
| Sentences that use active voice are easier to read. Active voice makes it clear who has done what and to whom. Plus, active voice keeps sentences direct and more concise. | ||
|
|
||
| Helping verbs such as is, was, or would may indicate that you're writing in passive voice. And, if you can add the phrase 'by zombies' after the verb, you're writing in the passive voice. | ||
|
|
||
| |Correct| Incorrect| | ||
| |:--|:--| | ||
| |Increase productivity with Docker Desktop.| Productivity can be increased (by zombies) with Docker Desktop.| | ||
| |If you remove items from a grid, charts automatically refresh to display the change. | If items are removed (by zombies) from a grid, charts automatically refresh to display the change.| | ||
|
|
||
| ##### Written clear sentences that get to the point | ||
|
|
||
| Write short, concise sentences. Punchy sentences are faster to read and easier to understand. | ||
|
|
||
| ##### Used subheadings and bulleted lists to break up the page | ||
|
|
||
| This helps ‘scanners’ find the information they need quickly and easily. | ||
|
|
||
| For more information, see the [formtatting](style/formatting.md#headings-and-subheadings) page, or see the [components](components/lists.md) for examples. | ||
|
|
||
| ##### Started the title of your page with a verb | ||
|
|
||
| For example, 'Install Docker Desktop'. | ||
|
|
||
| ##### Checked that the left-hand table of contents title in docs.docker.com, matches the title displayed on the page | ||
|
|
||
| ##### Checked for broken links and images | ||
|
|
||
| Use relative links to link to other pages or images within the docker.github.io repository. | ||
|
|
||
| For more information, see the [formatting](style/formatting.md#links) page, or see the [components](components/links.md) for examples. | ||
|
|
||
| ##### Checked that any redirects you may have added, work | ||
|
|
||
| For information on how to add redirects, see [Source file conventions](file-conventions.md#frontmatter). | ||
|
|
||
| ##### Used bold on any UI elements you refer to in your content | ||
|
|
||
| ##### Completed a final spelling, punctuation, and grammar check | ||
|
|
||
| For more in-depth information on our Style Guide, explore the [Grammar](style/grammar.md) or [Formatting](style/formatting.md) guides. | ||
|
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we should hide the contribute section from the landing page. But, it looks like that would also require some CSS changes, too. The home page already contains the additional "Articles" link, and adding contribute as well makes it rather wide. The media query looks like it's set to collapse the nav menu at 768px, which is narrower than the width of the navbar if we also add contribute.
Easy solution would be to remove the Articles (blog) link. Do we really need it? :D