mirror of https://github.com/docker/docs.git
parent
69c0e806a6
commit
9cc3c53c56
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Contribute to Docker's docs
|
||||
weight: 10
|
||||
toc_max: 1
|
||||
aliases:
|
||||
- /opensource/
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
title: Writing checklist
|
||||
description: A helpful writing checklist when creating documentation
|
||||
keywords: checklist, documentation, style guide, contribute
|
||||
weight: 60
|
||||
---
|
||||
|
||||
Use this checklist to communicate in a way that is clear, helpful, and consistent with the rest of Docker Docs.
|
||||
|
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
build:
|
||||
render: never
|
||||
title: Useful components
|
||||
weight: 50
|
||||
---
|
|
@ -2,6 +2,7 @@
|
|||
title: Source file conventions
|
||||
description: How new .md files should be formatted
|
||||
keywords: source file, contribute, style guide
|
||||
weight: 30
|
||||
---
|
||||
|
||||
## File name
|
||||
|
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
build:
|
||||
render: never
|
||||
title: Style guide
|
||||
weight: 20
|
||||
---
|
|
@ -3,6 +3,7 @@ title: Formatting guide
|
|||
description: Formatting guidelines for technical documentation
|
||||
keywords: formatting, style guide, contribute
|
||||
toc_max: 2
|
||||
weight: 20
|
||||
---
|
||||
|
||||
## Headings and subheadings
|
||||
|
|
|
@ -3,6 +3,7 @@ title: Grammar and style
|
|||
description: Grammar and style guidelines for technical documentation
|
||||
keywords: grammar, style, contribute
|
||||
toc_max: 2
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Docker documentation should always be written in US English with US grammar.
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
title: Recommended word list
|
||||
description: Recommended word list for Technical documentation
|
||||
keywords: recommended word list, style guide, contribute
|
||||
weight: 30
|
||||
---
|
||||
|
||||
To help ensure consistency across documentation, the Technical Writing team recommends these wording choices.
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
title: UI elements in content
|
||||
description: How to refer and interact with UI content
|
||||
keywords: ui, contribute, style guide
|
||||
weight: 40
|
||||
---
|
||||
|
||||
This page contains information on how to write technical content that involves a user interface (UI).
|
||||
|
|
Loading…
Reference in New Issue