Browse code

Remove `sources/` under `docs` directory

See #13936.

Signed-off-by: ChaYoung You <yousbe@gmail.com>

ChaYoung You authored on 2015/06/16 19:14:37
Showing 9 changed files
... ...
@@ -4,7 +4,7 @@ Want to hack on Docker? Awesome!  We have a contributor's guide that explains
4 4
 [setting up a Docker development environment and the contribution
5 5
 process](https://docs.docker.com/project/who-written-for/). 
6 6
 
7
-![Contributors guide](docs/sources/static_files/contributors.png)
7
+![Contributors guide](docs/static_files/contributors.png)
8 8
 
9 9
 This page contains information about reporting issues as well as some tips and
10 10
 guidelines useful to experienced open source contributors. Finally, make sure
... ...
@@ -18,7 +18,7 @@ It benefits directly from the experience accumulated over several years
18 18
 of large-scale operation and support of hundreds of thousands of
19 19
 applications and databases.
20 20
 
21
-![Docker L](docs/sources/static_files/docker-logo-compressed.png "Docker")
21
+![Docker L](docs/static_files/docker-logo-compressed.png "Docker")
22 22
 
23 23
 ## Security Disclosure
24 24
 
... ...
@@ -6,7 +6,7 @@ draft = true
6 6
 
7 7
 # Docker Documentation
8 8
 
9
-The source for Docker documentation is in this directory under `sources/`. Our
9
+The source for Docker documentation is in this directory. Our
10 10
 documentation uses extended Markdown, as implemented by
11 11
 [MkDocs](http://mkdocs.org).  The current release of the Docker documentation
12 12
 resides on [https://docs.docker.com](https://docs.docker.com).
... ...
@@ -60,7 +60,7 @@ own.
60 60
 	release. It also allows docs maintainers to easily cherry-pick your changes
61 61
 	into the `docs` release branch. 
62 62
 
63
-4. Modify existing or add new `.md` files to the `docs/sources` directory.
63
+4. Modify existing or add new `.md` files to the `docs` directory.
64 64
 
65 65
 	If you add a new document (`.md`) file, you must also add it to the
66 66
 	appropriate section of the `docs/mkdocs.yml` file in this repository.
... ...
@@ -113,7 +113,7 @@ links that are referenced in the documentation&mdash;there should be none.
113 113
 ## Style guide
114 114
 
115 115
 If you have questions about how to write for Docker's documentation, please see
116
-the [style guide](sources/project/doc-style.md). The style guide provides
116
+the [style guide](project/doc-style.md). The style guide provides
117 117
 guidance about grammar, syntax, formatting, styling, language, or tone. If
118 118
 something isn't clear in the guide, please submit an issue to let us know or
119 119
 submit a pull request to help us improve it.
... ...
@@ -9,7 +9,7 @@ so my process is
9 9
 
10 10
 $ boot2docker ssh
11 11
 $$ git clone https://github.com/docker/docker
12
-$$ cd docker/docs/sources/articles/https
12
+$$ cd docker/docs/articles/https
13 13
 $$ make cert
14 14
 lots of things to see and manually answer, as openssl wants to be interactive
15 15
 **NOTE:** make sure you enter the hostname (`boot2docker` in my case) when prompted for `Computer Name`)
... ...
@@ -18,7 +18,7 @@ $$ sudo make run
18 18
 start another terminal
19 19
 
20 20
 $ boot2docker ssh
21
-$$ cd docker/docs/sources/articles/https
21
+$$ cd docker/docs/articles/https
22 22
 $$ make client
23 23
 
24 24
 the last will connect first with `--tls` and then with `--tlsverify`
... ...
@@ -83,8 +83,8 @@ To update your existing pull request:
83 83
         # Your branch is up-to-date with 'origin/11038-fix-rhel-link'.
84 84
         #
85 85
         # Changes to be committed:
86
-        #		modified:   docs/sources/installation/mac.md
87
-        #		modified:   docs/sources/installation/rhel.md
86
+        #		modified:   docs/installation/mac.md
87
+        #		modified:   docs/installation/rhel.md
88 88
 
89 89
 5. Force push the change to your origin.
90 90
 
... ...
@@ -274,7 +274,7 @@ make any changes just run these commands again.
274 274
 
275 275
 ## Build and test the documentation
276 276
 
277
-The Docker documentation source files are under `docs/sources`. The content is
277
+The Docker documentation source files are under `docs`. The content is
278 278
 written using extended Markdown. We use the static generator <a
279 279
 href="http://www.mkdocs.org/" target="_blank">MkDocs</a> to build Docker's
280 280
 documentation. Of course, you don't need to install this generator
... ...
@@ -97,16 +97,16 @@ Follow this workflow as you work:
97 97
           (use "git add <file>..." to update what will be committed)
98 98
           (use "git checkout -- <file>..." to discard changes in working directory)
99 99
 
100
-        modified:   docs/sources/installation/mac.md
101
-        modified:   docs/sources/installation/rhel.md
100
+        modified:   docs/installation/mac.md
101
+        modified:   docs/installation/rhel.md
102 102
 
103 103
     The `status` command lists what changed in the repository. Make sure you see
104 104
     the changes you expect.
105 105
 
106 106
 7. Add your change to Git.
107 107
 
108
-        $ git add docs/sources/installation/mac.md
109
-        $ git add docs/sources/installation/rhel.md
108
+        $ git add docs/installation/mac.md
109
+        $ git add docs/installation/rhel.md
110 110
 
111 111
 
112 112
 8. Commit your changes making sure you use the `-s` flag to sign your work.
... ...
@@ -1,7 +1,7 @@
1 1
 Static files dir
2 2
 ================
3 3
 
4
-Files you put in /sources/static_files/ will be copied to the web visible /_static/
4
+Files you put in /static_files/ will be copied to the web visible /_static/
5 5
 
6 6
 Be careful not to override pre-existing static files from the template.
7 7
 
... ...
@@ -55,7 +55,7 @@ We don't want to stop contributions to master just because we are releasing. At
55 55
 the same time, now that the release branch exists, we don't want API changes to
56 56
 go to the now frozen API version.
57 57
 
58
-Create a new entry in `docs/sources/reference/api/` by copying the latest and
58
+Create a new entry in `docs/reference/api/` by copying the latest and
59 59
 bumping the version number (in both the file's name and content), and submit
60 60
 this in a PR against master.
61 61