docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ENGDOCS-2233 (#21005) 

* ENGDOCS-2233

* more weights
This commit is contained in:
Allie Sadler 2024-09-26 14:17:07 +01:00 committed by GitHub
parent 69c0e806a6
commit 9cc3c53c56
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
content/contribute/_index.md
View File

@ -1,5 +1,6 @@
--- ---
title: Contribute to Docker's docs title: Contribute to Docker's docs
weight: 10
toc_max: 1 toc_max: 1
aliases: aliases:
- /opensource/ - /opensource/

1
content/contribute/checklist.md
View File

@ -2,6 +2,7 @@
title: Writing checklist title: Writing checklist
description: A helpful writing checklist when creating documentation description: A helpful writing checklist when creating documentation
keywords: checklist, documentation, style guide, contribute 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. Use this checklist to communicate in a way that is clear, helpful, and consistent with the rest of Docker Docs.

6
content/contribute/components/_index.md Normal file
View File

@ -0,0 +1,6 @@
---
build:
render: never
title: Useful components
weight: 50
---

1
content/contribute/file-conventions.md
View File

@ -2,6 +2,7 @@
title: Source file conventions title: Source file conventions
description: How new .md files should be formatted description: How new .md files should be formatted
keywords: source file, contribute, style guide keywords: source file, contribute, style guide
weight: 30
--- ---
## File name ## File name

6
content/contribute/style/_index.md Normal file
View File

@ -0,0 +1,6 @@
---
build:
render: never
title: Style guide
weight: 20
---

1
content/contribute/style/formatting.md
View File

@ -3,6 +3,7 @@ title: Formatting guide
description: Formatting guidelines for technical documentation description: Formatting guidelines for technical documentation
keywords: formatting, style guide, contribute keywords: formatting, style guide, contribute
toc_max: 2 toc_max: 2
weight: 20
--- ---
## Headings and subheadings ## Headings and subheadings

1
content/contribute/style/grammar.md
View File

@ -3,6 +3,7 @@ title: Grammar and style
description: Grammar and style guidelines for technical documentation description: Grammar and style guidelines for technical documentation
keywords: grammar, style, contribute keywords: grammar, style, contribute
toc_max: 2 toc_max: 2
weight: 10
--- ---
Docker documentation should always be written in US English with US grammar. Docker documentation should always be written in US English with US grammar.

1
content/contribute/style/recommended-words.md
View File

@ -2,6 +2,7 @@
title: Recommended word list title: Recommended word list
description: Recommended word list for Technical documentation description: Recommended word list for Technical documentation
keywords: recommended word list, style guide, contribute keywords: recommended word list, style guide, contribute
weight: 30
--- ---
To help ensure consistency across documentation, the Technical Writing team recommends these wording choices. To help ensure consistency across documentation, the Technical Writing team recommends these wording choices.

1
content/contribute/ui.md
View File

@ -2,6 +2,7 @@
title: UI elements in content title: UI elements in content
description: How to refer and interact with UI content description: How to refer and interact with UI content
keywords: ui, contribute, style guide keywords: ui, contribute, style guide
weight: 40
--- ---
This page contains information on how to write technical content that involves a user interface (UI). This page contains information on how to write technical content that involves a user interface (UI).