centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 14:28:47 +07:00
Code Issues Packages Projects Releases Wiki Activity

Update test-and-docs.md (#4627)

Browse Source
This commit is contained in:
Wang Jie
2017-09-15 02:50:56 +08:00
committed by Joao Fernandes
parent 7a6d728770
commit 67e53c0676
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
opensource/project/test-and-docs.md
View File

@@ -259,13 +259,13 @@ When you change a documentation source file, you should test your change
locally to make sure your content is there and any links work correctly. You
can build the documentation from the local host.
### Building the docs for docs.docker.com
### Build the docs for docs.docker.com
You can build the docs using a Docker container or by using Jekyll directly.
Using the Docker container requires no set-up but is slower. Using Jekyll
directly requires you to install some prerequisites, but is faster on each build.
#### Using Docker Compose
#### Use Docker Compose
The easiest way to build the docs locally on macOS, Windows, or Linux is to use
`docker-compose`. If you have not yet installed `docker-compose`,
@@ -295,7 +295,7 @@ To start the container again, use the following command:
$ docker-compose start docs
```
#### Using Jekyll directly
#### Use Jekyll directly
If for some reason you are unable to use Docker Compose, you can use Jekyll directly.
@@ -341,7 +341,7 @@ Review your documentation changes on the local or Github Pages site. When you
are satisfied with your changes, submit your pull request.
### Reviewing the reference docs for your project
### Review the reference docs for your project
Some projects, such as Docker Engine, maintain reference documents, such as man
pages, CLI command references, and API endpoint references. These files are