Skip to content
Merged
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ We've made it really easy for you to file new issues.
We value your contribution. We'd like to make it as easy as possible to submit
your contributions to the Docker docs repository. Changes to the docs are
handled through pull requests against the `master` branch. To learn how to
contribute, see [CONTRIBUTING.md](CONTRIBUTING.md).
contribute, see our [Contribute section](contribute/overview.md).

## Copyright and license

Expand Down
48 changes: 48 additions & 0 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ horizontalnav:
- title: Samples
path: /samples/
node: samples
- title: Contribute
path: /contribute/overview/
node: contribute
# TODO unify navbbar links: homepage currently has a custom "articles" link
hide_home: true
Copy link
Contributor

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


Expand Down Expand Up @@ -1641,3 +1644,48 @@ manuals:
title: Get Support
- path: /release-lifecycle/
title: Product release lifecycle
contribute:
- path: /contribute/overview/
title: Contribute to Docker's docs
- path: /contribute/contribute-guide/
title: Contribution guidelines
- sectiontitle: Style guide
section:
- path: /contribute/style/grammar/
title: Grammar and style
- path: /contribute/style/formatting/
title: Formatting
- path: /contribute/style/recommended-words/
title: Recommended word list
- path: /contribute/style/terminology/
title: Docker terminology
- path: /contribute/style/voice-tone/
title: Voice and tone
- path: /contribute/file-conventions/
title: Source file conventions
- sectiontitle: Useful components
section:
- path: /contribute/components/accordions/
title: Accordions
- path: /contribute/components/badges/
title: Badges
- path: /contribute/components/call-outs/
title: Call outs
- path: /contribute/components/cards/
title: Cards
- path: /contribute/components/images/
title: Images
- path: /contribute/components/links/
title: Links
- path: /contribute/components/lists/
title: Lists
- path: /contribute/components/tables/
title: Tables
- path: /contribute/components/tabs/
title: Tabs
- path: /contribute/components/tooltips/
title: Tooltips
- path: /contribute/components/videos/
title: Videos
- path: /contribute/checklist/
title: Writing checklist
3 changes: 2 additions & 1 deletion _layouts/landing.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
{%- if entry.hide_home -%}{% continue %}{%- endif -%}
<li{% if entry.node == "home" %} class=active{% endif %}><a href="{{ entry.path }}" id="{{ entry.node }}">{{ entry.title }}</a></li>
{%- endfor -%}
<li><a href="https://www.docker.com/blog/">Articles</a></li>
<li><a href="https://www.docker.com/blog/">Articles</a></li>
<li><a href="/contribute/overview/">Contribute</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>{% include theme-switch.html %}</li>
Expand Down
136 changes: 0 additions & 136 deletions components.md

This file was deleted.

55 changes: 55 additions & 0 deletions contribute/checklist.md
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.

Loading