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

urls (#1074) 

Signed-off-by: yupengzte <yu.peng36@zte.com.cn>
This commit is contained in:
Andy Yu 2017-01-11 06:56:22 +08:00 committed by John Mulhausen
parent 443d84ec34
commit 333fe83af9
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,7 +1,7 @@
# Docs @ Docker # Docs @ Docker
Welcome to the repo for our documentation. This is the source for the URL Welcome to the repo for our documentation. This is the source for the URL
served at https://docs.docker.com/. served at [https://docs.docker.com/](https://docs.docker.com/).
Feel free to send us pull requests and file issues. Our docs are completely Feel free to send us pull requests and file issues. Our docs are completely
open source and we deeply appreciate contributions from our community! open source and we deeply appreciate contributions from our community!
@ -9,7 +9,7 @@ open source and we deeply appreciate contributions from our community!
## Providing feedback ## Providing feedback
We really want your feedback, and we've made it easy. You can edit, rate, or We really want your feedback, and we've made it easy. You can edit, rate, or
file an issue at the bottom of every page on docs.docker.com. file an issue at the bottom of every page on [https://docs.docker.com/](https://docs.docker.com/).
**Please only file issues about the documentation in this repository.** One way **Please only file issues about the documentation in this repository.** One way
to think about this is that you should file a bug here if your issue is that you to think about this is that you should file a bug here if your issue is that you
@ -17,7 +17,7 @@ don't see something that should be in the docs, or you see something incorrect
or confusing in the docs. or confusing in the docs.
- If your problem is a general question about how to configure or use Docker, - If your problem is a general question about how to configure or use Docker,
consider asking a question on https://forums.docker.com instead. consider asking a question on [https://forums.docker.com](https://forums.docker.com) instead.
- If you have an idea for a new feature or behavior change in a specific aspect - If you have an idea for a new feature or behavior change in a specific aspect
of Docker, or have found a bug in part of Docker, please file that issue in of Docker, or have found a bug in part of Docker, please file that issue in
@ -69,7 +69,7 @@ your work on that project's `vnext` branch.** These branches were created by
cloning `master` and then importing a project's `master` branch's docs into it cloning `master` and then importing a project's `master` branch's docs into it
(at the time of the migration), in a way that preserved the commit history. When (at the time of the migration), in a way that preserved the commit history. When
a project has a release, its `vnext` branch will be merged into `master` and your a project has a release, its `vnext` branch will be merged into `master` and your
work will be visible on docs.docker.com. work will be visible on [https://docs.docker.com/](https://docs.docker.com/).
The following `vnext` branches currently exist: The following `vnext` branches currently exist:
@ -109,7 +109,7 @@ of the site is built using Netlify. If the site builds, you will see
Click **Details** to review the staged site or the errors that prevented it from Click **Details** to review the staged site or the errors that prevented it from
building. Review the staged site and amend your commit if necessary. Reviewers building. Review the staged site and amend your commit if necessary. Reviewers
will also check the staged site before merging the PR, to protect the integrity will also check the staged site before merging the PR, to protect the integrity
of [docs.docker.com](http://docs.docker.com/). of [https://docs.docker.com/](https://docs.docker.com/).
## Staging locally ## Staging locally
@ -145,7 +145,7 @@ You have three options:
``` ```
b. Install Ruby 2.3 or later as described in [Installing Ruby] b. Install Ruby 2.3 or later as described in [Installing Ruby]
(https://www.ruby-lang.org/en/documentation/installation/). (https://www.ruby-lang.org/en/documentation/installation/).
c. Install Bundler: c. Install Bundler:
@ -193,7 +193,7 @@ You have three options:
Feel free to link to `../foo.md` so that the docs are readable in GitHub, but keep in mind that Jekyll templating notation Feel free to link to `../foo.md` so that the docs are readable in GitHub, but keep in mind that Jekyll templating notation
`{% such as this %}` will render in raw text and not be processed. In general it's best to assume the docs are being read `{% such as this %}` will render in raw text and not be processed. In general it's best to assume the docs are being read
directly on docs.docker.com. directly on [https://docs.docker.com/](https://docs.docker.com/).
## Style guide ## Style guide