From 9cc3c53c560b4e8ea169d45ccecdac9e9fbdacae Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Thu, 26 Sep 2024 14:17:07 +0100 Subject: [PATCH] ENGDOCS-2233 (#21005) * ENGDOCS-2233 * more weights --- content/contribute/_index.md | 1 + content/contribute/checklist.md | 1 + content/contribute/components/_index.md | 6 ++++++ content/contribute/file-conventions.md | 1 + content/contribute/style/_index.md | 6 ++++++ content/contribute/style/formatting.md | 1 + content/contribute/style/grammar.md | 1 + content/contribute/style/recommended-words.md | 1 + content/contribute/ui.md | 1 + 9 files changed, 19 insertions(+) create mode 100644 content/contribute/components/_index.md create mode 100644 content/contribute/style/_index.md diff --git a/content/contribute/_index.md b/content/contribute/_index.md index 80fe578658..ac91353730 100644 --- a/content/contribute/_index.md +++ b/content/contribute/_index.md @@ -1,5 +1,6 @@ --- title: Contribute to Docker's docs +weight: 10 toc_max: 1 aliases: - /opensource/ diff --git a/content/contribute/checklist.md b/content/contribute/checklist.md index 2bf8d0550d..e9e8af6fea 100644 --- a/content/contribute/checklist.md +++ b/content/contribute/checklist.md @@ -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. diff --git a/content/contribute/components/_index.md b/content/contribute/components/_index.md new file mode 100644 index 0000000000..3c3ff89b1a --- /dev/null +++ b/content/contribute/components/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Useful components +weight: 50 +--- \ No newline at end of file diff --git a/content/contribute/file-conventions.md b/content/contribute/file-conventions.md index 4abf27d88c..c2166ca2bf 100644 --- a/content/contribute/file-conventions.md +++ b/content/contribute/file-conventions.md @@ -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 diff --git a/content/contribute/style/_index.md b/content/contribute/style/_index.md new file mode 100644 index 0000000000..92afe3cb3b --- /dev/null +++ b/content/contribute/style/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Style guide +weight: 20 +--- \ No newline at end of file diff --git a/content/contribute/style/formatting.md b/content/contribute/style/formatting.md index 850ebd3edb..5cc5e1d3f0 100644 --- a/content/contribute/style/formatting.md +++ b/content/contribute/style/formatting.md @@ -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 diff --git a/content/contribute/style/grammar.md b/content/contribute/style/grammar.md index 422d02157a..4e0bcb5368 100644 --- a/content/contribute/style/grammar.md +++ b/content/contribute/style/grammar.md @@ -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. diff --git a/content/contribute/style/recommended-words.md b/content/contribute/style/recommended-words.md index 19ee3091c4..ae4db752d2 100644 --- a/content/contribute/style/recommended-words.md +++ b/content/contribute/style/recommended-words.md @@ -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. diff --git a/content/contribute/ui.md b/content/contribute/ui.md index 8146c772fa..d2b72144ed 100644 --- a/content/contribute/ui.md +++ b/content/contribute/ui.md @@ -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).