Commit Graph

51 Commits

Author SHA1 Message Date
293fc1d57e Add a missing definite article
Signed-off-by: Michael West <mwest@mdsol.com>
Upstream-commit: 229fa7b7b9
Component: cli
2017-06-02 00:06:52 +00:00
3ac223b9b7 Add man pages generation instructions.
Signed-off-by: Michael West <mwest@mdsol.com>
Upstream-commit: 443da2a625
Component: cli
2017-06-02 00:06:52 +00:00
21300d2002 Updating in light of new contributors guide
Link to new guide. Added a quickstart contributor guide for experienced people.
Converting narrative style to procedures for easier use. I think there is something missing in the
release publishing section...but it looks like it was missing in the original.
Updates per thaJeztah
Edits per Fred
Updating with comments from Sven

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: fc39612aaa
Component: cli
2017-06-02 00:06:51 +00:00
555c8026aa Add "eval" to every invocation of "boot2docker shellinit"
See http://unix.stackexchange.com/a/181581 for the rationale behind this change.

Signed-off-by: Andrew "Tianon" Page <admwiggin@gmail.com>
Upstream-commit: fd05b908be
Component: cli
2017-06-02 00:06:50 +00:00
4ebb37f92b Show how to remove a file from the docs s3 bucket, and then invalidate the cloudflare cache
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 863f296d3a
Component: cli
2017-06-02 00:06:48 +00:00
2bba386e30 Clean up explanation of doc branches.
Signed-off-by: Peter Salvatore <peter@psftw.com>
Upstream-commit: e2ac0fc917
Component: cli
2017-06-02 00:06:47 +00:00
9882c59f32 Format awsconfig sample config correctly
Reflow change in commit 195f3a3f removed newlines in the config format.

This change reverts the sample config to the original formatting, which
matches the actual config format of a `awsconfig` file.

Signed-off-by: Katie McLaughlin <katie@glasnt.com>
Upstream-commit: 2fedce8411
Component: cli
2017-06-02 00:06:46 +00:00
417805a657 An initial quick import of documentation from Compose, Machine and Swarm
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: ff12640c2b
Component: cli
2017-06-02 00:06:45 +00:00
c998ef06dc Add docs Cloudfront cache invalidation
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
Upstream-commit: bc5dd0cd32
Component: cli
2017-06-02 00:06:44 +00:00
b39e021d90 add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 1cc7a4eb81
Component: cli
2017-06-02 00:06:43 +00:00
86a734c304 Something changed, broke the docs release script, and it seems that --exclude still doesn't work, so I'm removing it
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: bc4f74bc1d
Component: cli
2017-06-02 00:06:42 +00:00
1edc2957dc Removed extraneous )
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 407a4a1916
Component: cli
2017-06-02 00:06:42 +00:00
a4a835cb0f Adds new Docs Style Guide.
Includes changes to mkdocs yml and removes style info from docs Read Me, adding a link instead.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)

Conflicts:
	docs/README.md

Revisions to style guide based on review.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)

More Style Guide revisions based on review.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)

A few more style guide copy edits

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: c90e4b1bc5
Component: cli
2017-06-02 00:06:37 +00:00
6be37a99f8 Mention the mkdocs.yml file for adding new documents
and move the complicated discussion about branches lower down,
hopefully most won't need to know

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: eecd9e7003
Component: cli
2017-06-02 00:06:36 +00:00
d96d75fc36 Changes to Sven's cherry pick process
Added content and revised after walk-through

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: 65c06ca59a
Component: cli
2017-06-02 00:06:33 +00:00
9ac8a8393d Adding Docs Deploy process to Docs ReadMe
Additions and revisions to Sven's cherry-pick process doc.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: 90d2156bc6
Component: cli
2017-06-02 00:06:33 +00:00
ae3f325e13 document the cherry-pick process I'm using to make docs updates
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: 621e17a267
Component: cli
2017-06-02 00:06:33 +00:00
5aee68c291 update go import path and libcontainer
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 4fc06d1790
Component: cli
2017-06-02 00:06:32 +00:00
1ca7ae869d I'm going to wish I didn't do this
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: 6f03f597ad
Component: cli
2017-06-02 00:06:30 +00:00
6bd98835aa blindly make all uses of e\.?g\.? into e.g.,
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: dd0cd23fd7
Component: cli
2017-06-02 00:06:30 +00:00
ccb97e17cc Fix spelling and grammar errors; remove seemingly out-of-place words
Docker-DCO-1.1-Signed-off-by: AJ Bowen <aj@gandi.net> (github: soulshake)
Upstream-commit: 3a348dab9b
Component: cli
2017-06-02 00:06:29 +00:00
9047b6bd9d Minor fixups to the Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: a8f2402b87
Component: cli
2017-06-02 00:06:27 +00:00
8e4c0ae838 Add a mention of 80 column lines and reflow the document to hide the
evidence.

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: 93ee19119b
Component: cli
2017-06-02 00:06:27 +00:00
cf249fbd1e Rearrange the existing info a little, and add example style guide
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 0137184cb6
Component: cli
2017-06-02 00:06:27 +00:00
d4f737dfb4 Replaced all double backticks in README with singles
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: d5b9bea76f
Component: cli
2017-06-02 00:06:26 +00:00
608e01a1af Updated Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 1e3f899705
Component: cli
2017-06-02 00:06:26 +00:00
c8b665e4fa simplify the docs branch process for now
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 742c981b37
Component: cli
2017-06-02 00:06:25 +00:00
4265be6b39 move the documentation to markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
Upstream-commit: d39c8aea47
Component: cli
2017-06-02 00:06:25 +00:00
24c6f1a33b update links
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
Upstream-commit: 2be94a6d55
Component: cli
2017-06-02 00:06:21 +00:00
c878f08021 Update the documentation docs with new branch information.
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
Upstream-commit: 2af848ac2c
Component: cli
2017-06-02 00:06:21 +00:00
21a737b698 Mac OSX command for pip was incorrect
Upstream-commit: fb17f9fcab
Component: cli
2017-06-02 00:06:19 +00:00
1c211d0906 make docs is more consistent
Upstream-commit: 2d576ea3b6
Component: cli
2017-06-02 00:06:19 +00:00
ab0c9a7cea change the policy wrt $ sudo docker to simplify auto-testing
Upstream-commit: 3091ba88fa
Component: cli
2017-06-02 00:06:19 +00:00
768974c22a Corrects misspellings of 'Sphinx'
Upstream-commit: 01d4e98cc8
Component: cli
2017-06-02 00:06:19 +00:00
ff73503948 Suggest users install dependencies by using requirements.txt, not manually
Upstream-commit: b52c999103
Component: cli
2017-06-02 00:06:19 +00:00
e5bc16370d add links to the Dockerfiles as canonical external requirements, add example of building and exposing the docs and simplify the Dockerfile for cacheability
Upstream-commit: 23e91a6d7f
Component: cli
2017-06-02 00:06:19 +00:00
199feb6224 Clean up level 3 headers.
Upstream-commit: bed37d2204
Component: cli
2017-06-02 00:06:19 +00:00
9463d1159a Fix #1919 document how to edit and release docs.
Upstream-commit: ce220ef43b
Component: cli
2017-06-02 00:06:19 +00:00
43d8f667fd Fixed typos
Upstream-commit: 147b04ce2b
Component: cli
2017-06-02 00:06:19 +00:00
d7f43325f2 Fixed some typo's and formatting issues in remote api documentation.
Upstream-commit: 22ab3ddc8a
Component: cli
2017-06-02 00:06:19 +00:00
67f5bb8bb9 Some more improvements on the docs readme. Removed references to website.
Upstream-commit: 2216afb617
Component: cli
2017-06-02 00:06:19 +00:00
34f087441b Updated docs README with instructions to preview the generated manfile, and where to get the one generated by sphinx.
Upstream-commit: 9c5f4391e1
Component: cli
2017-06-02 00:06:19 +00:00
cdc3377009 Enabled the docs to generate manpages.
* changed conf.py to reference toctree.rst instead of index
* Added note to README to upgrade your sphinx to the latest version to prevent a bug with .. note:: blocks.
Upstream-commit: 77926c6033
Component: cli
2017-06-02 00:06:19 +00:00
99a1852177 Make style consistent
Upstream-commit: 74428120af
Component: cli
2017-06-02 00:06:19 +00:00
95534b5821 Add Mac OS X instructions for doc tools
Upstream-commit: 3c035fa508
Component: cli
2017-06-02 00:06:19 +00:00
d08724ab40 Add make server command to preview docs
Upstream-commit: 99dfa4e7e8
Component: cli
2017-06-02 00:06:18 +00:00
aec84e0e64 Updated index to reflect new (short) 'engine' message (merged with solomon's new text), also moved around the layout a bit and fixed some small text errors.
Upstream-commit: 6d79cab514
Component: cli
2017-06-02 00:06:18 +00:00
c6d0d33e87 Added code and color for 'note' and updated the hello world note.
Upstream-commit: f4399fe403
Component: cli
2017-06-02 00:06:18 +00:00
9d6a9f36e8 Improved README
Upstream-commit: 8a39a45f05
Component: cli
2017-06-02 00:06:18 +00:00
b07dff2c8e Merge of docker-website into the docker documentation.
Upstream-commit: 244477e27f
Component: cli
2017-06-02 00:06:18 +00:00