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

Fix several missing periods

This commit is contained in:
Christian Veenhuis 2023-03-03 20:21:26 +00:00
parent db02cfa0b5
commit 5743681cf5
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
contribute/contribute-guide.md
View File

@ -27,10 +27,10 @@ There are two ways to contribute a pull request to the docs repository:
Here’s a list of some of the important files: Here’s a list of some of the important files:
- `/_data/toc.yaml` defines the left-hand navigation for the docs - `/_data/toc.yaml` defines the left-hand navigation for the docs.
- `/js/docs.js` defines most of the docs-specific JS such as the table of contents (ToC) generation and menu syncing - `/js/docs.js` defines most of the docs-specific JS such as the table of contents (ToC) generation and menu syncing.
- `/css/style.scss` defines the docs-specific style rules - `/css/style.scss` defines the docs-specific style rules.
- `/_layouts/docs.html` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content - `/_layouts/docs.html` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content.
### Files not edited here ### Files not edited here
@ -71,7 +71,7 @@ git clone {{ site.repo }}.git
cd docs cd docs
``` ```
Then, build and run the documentation using [Docker Compose](../compose/index.md) Then, build and run the documentation using [Docker Compose](../compose/index.md):
```bash ```bash
docker compose up -d --build docker compose up -d --build

2
contribute/overview.md
View File

@ -76,7 +76,7 @@ as possible for you to work in this repository. The following sections guide you
We also provide: We also provide:
- A section of useful components you can add to your documentation. For components and controls, we use [Bootstrap](https://getbootstrap.com) - A section of useful components you can add to your documentation. For components and controls, we use [Bootstrap](https://getbootstrap.com).
- Information on Docker's [tone and voice](style/voice-tone.md). - Information on Docker's [tone and voice](style/voice-tone.md).
- A [writing checklist](checklist.md) to help you when you're contributing to Docker's documentation. - A [writing checklist](checklist.md) to help you when you're contributing to Docker's documentation.
- A command-line tool called vale to check the style and [help you find errors in your writing](contribute-guide.md#test-the-docs-locally). - A command-line tool called vale to check the style and [help you find errors in your writing](contribute-guide.md#test-the-docs-locally).

2
contribute/style/formatting.md
View File

@ -25,7 +25,7 @@ Page titles should be action orientated. For example:
### Best practice: ### Best practice:
- Make sure the title of your page and the TOC entry matches - Make sure the title of your page and the TOC entry matches.
- If you want to use a ‘:’ in a page title in the table of contents (_toc.yaml), you must wrap the entire title in “” to avoid breaking the build. - If you want to use a ‘:’ in a page title in the table of contents (_toc.yaml), you must wrap the entire title in “” to avoid breaking the build.
## Images ## Images