Skip to content

Commit 3f4eeca

Browse files
committed
Remove sources/ under docs directory
See moby#13936. Signed-off-by: ChaYoung You <yousbe@gmail.com>
1 parent 9dffd03 commit 3f4eeca

File tree

9 files changed

+16
-16
lines changed

9 files changed

+16
-16
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Want to hack on Docker? Awesome! We have a contributor's guide that explains
44
[setting up a Docker development environment and the contribution
55
process](https://docs.docker.com/project/who-written-for/).
66

7-
![Contributors guide](docs/sources/static_files/contributors.png)
7+
![Contributors guide](docs/static_files/contributors.png)
88

99
This page contains information about reporting issues as well as some tips and
1010
guidelines useful to experienced open source contributors. Finally, make sure

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ It benefits directly from the experience accumulated over several years
1818
of large-scale operation and support of hundreds of thousands of
1919
applications and databases.
2020

21-
![Docker L](docs/sources/static_files/docker-logo-compressed.png "Docker")
21+
![Docker L](docs/static_files/docker-logo-compressed.png "Docker")
2222

2323
## Security Disclosure
2424

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ draft = true
66

77
# Docker Documentation
88

9-
The source for Docker documentation is in this directory under `sources/`. Our
9+
The source for Docker documentation is in this directory. Our
1010
documentation uses extended Markdown, as implemented by
1111
[MkDocs](http://mkdocs.org). The current release of the Docker documentation
1212
resides on [https://docs.docker.com](https://docs.docker.com).
@@ -60,7 +60,7 @@ own.
6060
release. It also allows docs maintainers to easily cherry-pick your changes
6161
into the `docs` release branch.
6262

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.
6464

6565
If you add a new document (`.md`) file, you must also add it to the
6666
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.
113113
## Style guide
114114

115115
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
117117
guidance about grammar, syntax, formatting, styling, language, or tone. If
118118
something isn't clear in the guide, please submit an issue to let us know or
119119
submit a pull request to help us improve it.

docs/articles/https/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ so my process is
99

1010
$ boot2docker ssh
1111
$$ git clone https://github.com/docker/docker
12-
$$ cd docker/docs/sources/articles/https
12+
$$ cd docker/docs/articles/https
1313
$$ make cert
1414
lots of things to see and manually answer, as openssl wants to be interactive
1515
**NOTE:** make sure you enter the hostname (`boot2docker` in my case) when prompted for `Computer Name`)
@@ -18,7 +18,7 @@ $$ sudo make run
1818
start another terminal
1919
2020
$ boot2docker ssh
21-
$$ cd docker/docs/sources/articles/https
21+
$$ cd docker/docs/articles/https
2222
$$ make client
2323
2424
the last will connect first with `--tls` and then with `--tlsverify`

docs/project/review-pr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ To update your existing pull request:
8383
# Your branch is up-to-date with 'origin/11038-fix-rhel-link'.
8484
#
8585
# 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
8888

8989
5. Force push the change to your origin.
9090

docs/project/test-and-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ make any changes just run these commands again.
274274

275275
## Build and test the documentation
276276

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
278278
written using extended Markdown. We use the static generator <a
279279
href="http://www.mkdocs.org/" target="_blank">MkDocs</a> to build Docker's
280280
documentation. Of course, you don't need to install this generator

docs/project/work-issue.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,16 +97,16 @@ Follow this workflow as you work:
9797
(use "git add <file>..." to update what will be committed)
9898
(use "git checkout -- <file>..." to discard changes in working directory)
9999

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
102102

103103
The `status` command lists what changed in the repository. Make sure you see
104104
the changes you expect.
105105

106106
7. Add your change to Git.
107107

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
110110

111111

112112
8. Commit your changes making sure you use the `-s` flag to sign your work.

docs/static_files/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Static files dir
22
================
33

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/
55

66
Be careful not to override pre-existing static files from the template.
77

project/RELEASE-CHECKLIST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ We don't want to stop contributions to master just because we are releasing. At
5555
the same time, now that the release branch exists, we don't want API changes to
5656
go to the now frozen API version.
5757

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
5959
bumping the version number (in both the file's name and content), and submit
6060
this in a PR against master.
6161

0 commit comments

Comments
 (0)