From 0a5b458333bde8ace115b694096afce91d3c8d10 Mon Sep 17 00:00:00 2001 From: Clint Joseph Date: Mon, 5 Sep 2022 14:40:42 +0530 Subject: [PATCH 1/4] Update mac-install.md (#15555) Typo in spelling of subscription. `subscri[tion` -> `subscription` --- desktop/install/mac-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/desktop/install/mac-install.md b/desktop/install/mac-install.md index 668de6dc323f..e56a76f8dcb9 100644 --- a/desktop/install/mac-install.md +++ b/desktop/install/mac-install.md @@ -88,7 +88,7 @@ Your Mac must meet the following requirements to install Docker Desktop successf > If you do not agree to the terms, the Docker Desktop application will close and you can no longer run Docker Desktop on your machine. You can choose to accept the terms at a later date by opening Docker Desktop. {: .important} - For more information, see [Docker Desktop Subscri[tion Service Agreement](https://www.docker.com/legal/docker-subscription-service-agreement). We recommend that you also read the [FAQs](https://www.docker.com/pricing/faq){: target="_blank" rel="noopener" class="_" id="dkr_docs_desktop_install_btl"}. + For more information, see [Docker Desktop Subscription Service Agreement](https://www.docker.com/legal/docker-subscription-service-agreement). We recommend that you also read the [FAQs](https://www.docker.com/pricing/faq){: target="_blank" rel="noopener" class="_" id="dkr_docs_desktop_install_btl"}. ### Install from the command line From 5291295d0d20c5ae566df4d9d8a19e52f7ee3562 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Mon, 5 Sep 2022 10:23:29 +0100 Subject: [PATCH 2/4] Addition of a 'Contribute' section with our Style Guide (#15350) * SG test. * moved some content around * editing * broken links fix * formatting changes * fixes * fixes * edits after review * fix broken links * broken link fix * a few more edits * removed contributing page * Revert "removed contributing page" This reverts commit 5822cd516bf059640e07d34450a44c26dbbbc77d. * add redirect --- README.md | 2 +- _data/toc.yaml | 48 ++ _layouts/landing.html | 3 +- components.md | 136 ---- contribute/checklist.md | 55 ++ contribute/components/accordions.md | 135 ++++ contribute/components/badges.md | 28 + contribute/components/call-outs.md | 72 +++ contribute/components/cards.md | 31 + contribute/components/code-blocks.md | 165 +++++ contribute/components/images.md | 35 ++ contribute/components/links.md | 38 ++ contribute/components/lists.md | 75 +++ contribute/components/tables.md | 31 + contribute/components/tabs.md | 107 ++++ contribute/components/tooltips.md | 39 ++ contribute/components/videos.md | 14 + contribute/contribute-guide.md | 124 ++++ contribute/file-conventions.md | 63 ++ contribute/overview.md | 80 +++ contribute/style/formatting.md | 136 ++++ contribute/style/grammar.md | 159 +++++ contribute/style/recommended-words.md | 107 ++++ contribute/style/terminology.md | 60 ++ contribute/style/voice-tone.md | 49 ++ images/check.svg | 4 + images/contribute.svg | 6 + images/formatting.svg | 4 + images/grammar.svg | 12 + images/new-page.svg | 6 + images/terminology.svg | 16 + test.md | 867 -------------------------- 32 files changed, 1702 insertions(+), 1005 deletions(-) delete mode 100644 components.md create mode 100644 contribute/checklist.md create mode 100644 contribute/components/accordions.md create mode 100644 contribute/components/badges.md create mode 100644 contribute/components/call-outs.md create mode 100644 contribute/components/cards.md create mode 100644 contribute/components/code-blocks.md create mode 100644 contribute/components/images.md create mode 100644 contribute/components/links.md create mode 100644 contribute/components/lists.md create mode 100644 contribute/components/tables.md create mode 100644 contribute/components/tabs.md create mode 100644 contribute/components/tooltips.md create mode 100644 contribute/components/videos.md create mode 100644 contribute/contribute-guide.md create mode 100644 contribute/file-conventions.md create mode 100644 contribute/overview.md create mode 100644 contribute/style/formatting.md create mode 100644 contribute/style/grammar.md create mode 100644 contribute/style/recommended-words.md create mode 100644 contribute/style/terminology.md create mode 100644 contribute/style/voice-tone.md create mode 100644 images/check.svg create mode 100644 images/contribute.svg create mode 100644 images/formatting.svg create mode 100644 images/grammar.svg create mode 100644 images/new-page.svg create mode 100644 images/terminology.svg delete mode 100644 test.md diff --git a/README.md b/README.md index 3a04e5ebc715..0b4d87d98c9d 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/_data/toc.yaml b/_data/toc.yaml index 46bb9a868f3a..7c7b2bc605ff 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -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 @@ -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 diff --git a/_layouts/landing.html b/_layouts/landing.html index 1204acd88206..634adfab3360 100644 --- a/_layouts/landing.html +++ b/_layouts/landing.html @@ -22,7 +22,8 @@ {%- if entry.hide_home -%}{% continue %}{%- endif -%} {{ entry.title }} {%- endfor -%} -
  • Articles
    • +
  • Articles
    • +
  • Contribute