mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Replaced all double backticks in README with singles
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
This commit is contained in:
parent
3b279d0218
commit
723d314f09
1 changed files with 27 additions and 29 deletions
|
@ -4,7 +4,7 @@ Docker Documentation
|
||||||
Overview
|
Overview
|
||||||
--------
|
--------
|
||||||
|
|
||||||
The source for Docker documentation is here under ``sources/`` and uses
|
The source for Docker documentation is here under `sources/` and uses
|
||||||
extended Markdown, as implemented by [mkdocs](http://mkdocs.org).
|
extended Markdown, as implemented by [mkdocs](http://mkdocs.org).
|
||||||
|
|
||||||
The HTML files are built and hosted on `https://docs.docker.io`, and
|
The HTML files are built and hosted on `https://docs.docker.io`, and
|
||||||
|
@ -16,36 +16,36 @@ the "master" documentation.
|
||||||
|
|
||||||
## Branches
|
## Branches
|
||||||
|
|
||||||
**There are two branches related to editing docs**: ``master`` and a
|
**There are two branches related to editing docs**: `master` and a
|
||||||
``docs`` branch. You should always edit documentation on a local branch
|
`docs` branch. You should always edit documentation on a local branch
|
||||||
of the ``master`` branch, and send a PR against ``master``.
|
of the `master` branch, and send a PR against `master`.
|
||||||
|
|
||||||
That way your fixes will automatically get included in later releases,
|
That way your fixes will automatically get included in later releases,
|
||||||
and docs maintainers can easily cherry-pick your changes into the
|
and docs maintainers can easily cherry-pick your changes into the
|
||||||
``docs`` release branch. In the rare case where your change is not
|
`docs` release branch. In the rare case where your change is not
|
||||||
forward-compatible, you may need to base your changes on the ``docs``
|
forward-compatible, you may need to base your changes on the `docs`
|
||||||
branch.
|
branch.
|
||||||
|
|
||||||
Also, now that we have a ``docs`` branch, we can keep the
|
Also, now that we have a `docs` branch, we can keep the
|
||||||
[http://docs.docker.io](http://docs.docker.io) docs up to date with any
|
[http://docs.docker.io](http://docs.docker.io) docs up to date with any
|
||||||
bugs found between ``docker`` code releases.
|
bugs found between `docker` code releases.
|
||||||
|
|
||||||
**Warning**: When *reading* the docs, the
|
**Warning**: When *reading* the docs, the
|
||||||
[http://beta-docs.docker.io](http://beta-docs.docker.io) documentation
|
[http://beta-docs.docker.io](http://beta-docs.docker.io) documentation
|
||||||
may include features not yet part of any official docker release. The
|
may include features not yet part of any official docker release. The
|
||||||
``beta-docs`` site should be used only for understanding bleeding-edge
|
`beta-docs` site should be used only for understanding bleeding-edge
|
||||||
development and ``docs.docker.io`` (which points to the ``docs``
|
development and `docs.docker.io` (which points to the `docs`
|
||||||
branch``) should be used for the latest official release.
|
branch`) should be used for the latest official release.
|
||||||
|
|
||||||
Getting Started
|
Getting Started
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Docker documentation builds are done in a Docker container, which
|
Docker documentation builds are done in a Docker container, which
|
||||||
installs all the required tools, adds the local ``docs/`` directory and
|
installs all the required tools, adds the local `docs/` directory and
|
||||||
builds the HTML docs. It then starts a HTTP server on port 8000 so that
|
builds the HTML docs. It then starts a HTTP server on port 8000 so that
|
||||||
you can connect and see your changes.
|
you can connect and see your changes.
|
||||||
|
|
||||||
In the root of the ``docker`` source directory:
|
In the root of the `docker` source directory:
|
||||||
|
|
||||||
cd docker
|
cd docker
|
||||||
|
|
||||||
|
@ -53,13 +53,13 @@ Run:
|
||||||
|
|
||||||
make docs
|
make docs
|
||||||
|
|
||||||
If you have any issues you need to debug, you can use ``make docs-shell`` and
|
If you have any issues you need to debug, you can use `make docs-shell` and
|
||||||
then run ``mkdocs serve``
|
then run `mkdocs serve`
|
||||||
|
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
* Follow the contribution guidelines ([see
|
* Follow the contribution guidelines ([see
|
||||||
``../CONTRIBUTING.md``](../CONTRIBUTING.md)).
|
`../CONTRIBUTING.md`](../CONTRIBUTING.md)).
|
||||||
* [Remember to sign your work!](../CONTRIBUTING.md#sign-your-work)
|
* [Remember to sign your work!](../CONTRIBUTING.md#sign-your-work)
|
||||||
|
|
||||||
Working using GitHub's file editor
|
Working using GitHub's file editor
|
||||||
|
@ -67,7 +67,7 @@ Working using GitHub's file editor
|
||||||
|
|
||||||
Alternatively, for small changes and typos you might want to use
|
Alternatively, for small changes and typos you might want to use
|
||||||
GitHub's built in file editor. It allows you to preview your changes
|
GitHub's built in file editor. It allows you to preview your changes
|
||||||
right online (though there can be some differences between GitHub
|
right on-line (though there can be some differences between GitHub
|
||||||
Markdown and mkdocs Markdown). Just be careful not to create many commits.
|
Markdown and mkdocs Markdown). Just be careful not to create many commits.
|
||||||
And you must still [sign your work!](../CONTRIBUTING.md#sign-your-work)
|
And you must still [sign your work!](../CONTRIBUTING.md#sign-your-work)
|
||||||
|
|
||||||
|
@ -75,26 +75,24 @@ Images
|
||||||
------
|
------
|
||||||
|
|
||||||
When you need to add images, try to make them as small as possible
|
When you need to add images, try to make them as small as possible
|
||||||
(e.g. as gif). Usually images should go in the same directory as the
|
(e.g. as gifs). Usually images should go in the same directory as the
|
||||||
.md file which references them, or in a subdirectory if one already
|
`.md` file which references them, or in a subdirectory if one already
|
||||||
exists.
|
exists.
|
||||||
|
|
||||||
Publishing Documentation
|
Publishing Documentation
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
To publish a copy of the documentation you need a ``docs/awsconfig``
|
To publish a copy of the documentation you need a `docs/awsconfig`
|
||||||
file containing AWS settings to deploy to. The release script will
|
file containing AWS settings to deploy to. The release script will
|
||||||
create an s3 if needed, and will then push the files to it.
|
create an s3 if needed, and will then push the files to it.
|
||||||
|
|
||||||
```
|
[profile dowideit-docs]
|
||||||
[profile dowideit-docs]
|
aws_access_key_id = IHOIUAHSIDH234rwf....
|
||||||
aws_access_key_id = IHOIUAHSIDH234rwf....
|
aws_secret_access_key = OIUYSADJHLKUHQWIUHE......
|
||||||
aws_secret_access_key = OIUYSADJHLKUHQWIUHE......
|
region = ap-southeast-2
|
||||||
region = ap-southeast-2
|
|
||||||
```
|
|
||||||
|
|
||||||
The ``profile`` name must be the same as the name of the bucket you are
|
The `profile` name must be the same as the name of the bucket you are
|
||||||
deploying to - which you call from the docker directory:
|
deploying to - which you call from the `docker` directory:
|
||||||
|
|
||||||
``make AWS_S3_BUCKET=dowideit-docs docs-release``
|
make AWS_S3_BUCKET=dowideit-docs docs-release
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue