diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fab92f6ca0..371acec9e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Want to hack on Docker? Awesome! We have a contributor's guide that explains [setting up a Docker development environment and the contribution process](https://docs.docker.com/project/who-written-for/). -![Contributors guide](docs/sources/static_files/contributors.png) +![Contributors guide](docs/static_files/contributors.png) This page contains information about reporting issues as well as some tips and guidelines useful to experienced open source contributors. Finally, make sure diff --git a/README.md b/README.md index 4c6e38831b..891240421d 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ It benefits directly from the experience accumulated over several years of large-scale operation and support of hundreds of thousands of applications and databases. -![Docker L](docs/sources/static_files/docker-logo-compressed.png "Docker") +![Docker L](docs/static_files/docker-logo-compressed.png "Docker") ## Security Disclosure diff --git a/docs/README.md b/docs/README.md index b8d50c8d91..e4413c5cd8 100755 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ draft = true # Docker Documentation -The source for Docker documentation is in this directory under `sources/`. Our +The source for Docker documentation is in this directory. Our documentation uses extended Markdown, as implemented by [MkDocs](http://mkdocs.org). The current release of the Docker documentation resides on [https://docs.docker.com](https://docs.docker.com). @@ -60,7 +60,7 @@ own. release. It also allows docs maintainers to easily cherry-pick your changes into the `docs` release branch. -4. Modify existing or add new `.md` files to the `docs/sources` directory. +4. Modify existing or add new `.md` files to the `docs` directory. If you add a new document (`.md`) file, you must also add it to the appropriate section of the `docs/mkdocs.yml` file in this repository. @@ -113,7 +113,7 @@ links that are referenced in the documentation—there should be none. ## Style guide If you have questions about how to write for Docker's documentation, please see -the [style guide](sources/project/doc-style.md). The style guide provides +the [style guide](project/doc-style.md). The style guide provides guidance about grammar, syntax, formatting, styling, language, or tone. If something isn't clear in the guide, please submit an issue to let us know or submit a pull request to help us improve it. diff --git a/docs/articles/https/README.md b/docs/articles/https/README.md index 3e1dd27f6e..1faca04a1a 100644 --- a/docs/articles/https/README.md +++ b/docs/articles/https/README.md @@ -9,7 +9,7 @@ so my process is $ boot2docker ssh $$ git clone https://github.com/docker/docker -$$ cd docker/docs/sources/articles/https +$$ cd docker/docs/articles/https $$ make cert lots of things to see and manually answer, as openssl wants to be interactive **NOTE:** make sure you enter the hostname (`boot2docker` in my case) when prompted for `Computer Name`) @@ -18,7 +18,7 @@ $$ sudo make run start another terminal $ boot2docker ssh -$$ cd docker/docs/sources/articles/https +$$ cd docker/docs/articles/https $$ make client the last will connect first with `--tls` and then with `--tlsverify` diff --git a/docs/project/review-pr.md b/docs/project/review-pr.md index b96bda4f0e..a61a6be13d 100644 --- a/docs/project/review-pr.md +++ b/docs/project/review-pr.md @@ -83,8 +83,8 @@ To update your existing pull request: # Your branch is up-to-date with 'origin/11038-fix-rhel-link'. # # Changes to be committed: - # modified: docs/sources/installation/mac.md - # modified: docs/sources/installation/rhel.md + # modified: docs/installation/mac.md + # modified: docs/installation/rhel.md 5. Force push the change to your origin. diff --git a/docs/project/test-and-docs.md b/docs/project/test-and-docs.md index 086528772e..1382b356b0 100644 --- a/docs/project/test-and-docs.md +++ b/docs/project/test-and-docs.md @@ -274,7 +274,7 @@ make any changes just run these commands again. ## Build and test the documentation -The Docker documentation source files are under `docs/sources`. The content is +The Docker documentation source files are under `docs`. The content is written using extended Markdown. We use the static generator MkDocs to build Docker's documentation. Of course, you don't need to install this generator diff --git a/docs/project/work-issue.md b/docs/project/work-issue.md index a2a1dc2ec6..7d5c3b7525 100644 --- a/docs/project/work-issue.md +++ b/docs/project/work-issue.md @@ -97,16 +97,16 @@ Follow this workflow as you work: (use "git add ..." to update what will be committed) (use "git checkout -- ..." to discard changes in working directory) - modified: docs/sources/installation/mac.md - modified: docs/sources/installation/rhel.md + modified: docs/installation/mac.md + modified: docs/installation/rhel.md The `status` command lists what changed in the repository. Make sure you see the changes you expect. 7. Add your change to Git. - $ git add docs/sources/installation/mac.md - $ git add docs/sources/installation/rhel.md + $ git add docs/installation/mac.md + $ git add docs/installation/rhel.md 8. Commit your changes making sure you use the `-s` flag to sign your work. diff --git a/docs/static_files/README.md b/docs/static_files/README.md index 99dc104d4c..f09a25af49 100644 --- a/docs/static_files/README.md +++ b/docs/static_files/README.md @@ -1,7 +1,7 @@ Static files dir ================ -Files you put in /sources/static_files/ will be copied to the web visible /_static/ +Files you put in /static_files/ will be copied to the web visible /_static/ Be careful not to override pre-existing static files from the template. diff --git a/project/RELEASE-CHECKLIST.md b/project/RELEASE-CHECKLIST.md index d2b9650805..00409094b1 100644 --- a/project/RELEASE-CHECKLIST.md +++ b/project/RELEASE-CHECKLIST.md @@ -55,7 +55,7 @@ We don't want to stop contributions to master just because we are releasing. At the same time, now that the release branch exists, we don't want API changes to go to the now frozen API version. -Create a new entry in `docs/sources/reference/api/` by copying the latest and +Create a new entry in `docs/reference/api/` by copying the latest and bumping the version number (in both the file's name and content), and submit this in a PR against master.