Commit Graph

58 Commits

Author SHA1 Message Date
Lai Jiangshan 11b6e1b9fd docs: fix file's permissions
The README.md and the *.png should not have the executable
permissions, remove them.

Signed-off-by: Lai Jiangshan <jiangshanlai@gmail.com>
2017-06-02 00:06:59 +00:00
ChaYoung You 7507a5b7ab Remove `sources/` under `docs` directory
See #13936.

Signed-off-by: ChaYoung You <yousbe@gmail.com>
2017-06-02 00:06:58 +00:00
Mary Anthony d1d033701e retooling for hugo
Tweaking for Hugo
Updating the Dockerfile with new sed; fix broken link on Kitematic
Fixing image pull for Dockerfile
Removing docs targets

Signed-off-by: Mary Anthony <mary@docker.com>
2017-06-02 00:06:58 +00:00
Mary Anthony 2b50e0f852 Carry of PR #13520
Removinig files

Signed-off-by: Mary Anthony <mary@docker.com>
2017-06-02 00:06:58 +00:00
Mary Anthony 77868b76b9 Moving man pages out of docs
Adding in other areas per comments
Updating with comments; equalizing generating man page info
Updating with duglin's comments
Doug is right here again;fixing.

Signed-off-by: Mary Anthony <mary@docker.com>
2017-06-02 00:06:57 +00:00
Jessica Frazelle 9ac00da7ce Update urls from .com to .org.
I added 301 redirects from dockerproject.com to dockerproject.org but may as
well make sure everything is updated anyways.

Signed-off-by: Jessica Frazelle <princess@docker.com>
2017-06-02 00:06:57 +00:00
Eric Windisch b22aaac047 HTTPS URLs for docs top-level & man pages
This updates all of docs outside of sources.

Signed-off-by: Eric Windisch <eric@windisch.us>
2017-06-02 00:06:54 +00:00
Michael West 229fa7b7b9 Add a missing definite article
Signed-off-by: Michael West <mwest@mdsol.com>
2017-06-02 00:06:52 +00:00
Michael West 443da2a625 Add man pages generation instructions.
Signed-off-by: Michael West <mwest@mdsol.com>
2017-06-02 00:06:52 +00:00
Mary Anthony fc39612aaa 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>
2017-06-02 00:06:51 +00:00
Tianon Gravi fd05b908be 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>
2017-06-02 00:06:50 +00:00
Sven Dowideit 863f296d3a 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>
2017-06-02 00:06:48 +00:00
Peter Salvatore e2ac0fc917 Clean up explanation of doc branches.
Signed-off-by: Peter Salvatore <peter@psftw.com>
2017-06-02 00:06:47 +00:00
Katie McLaughlin 2fedce8411 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>
2017-06-02 00:06:46 +00:00
Sven Dowideit ff12640c2b 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)
2017-06-02 00:06:45 +00:00
Sven Dowideit bc5dd0cd32 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>
2017-06-02 00:06:44 +00:00
Sven Dowideit 1cc7a4eb81 add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:43 +00:00
Sven Dowideit bc4f74bc1d 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>
2017-06-02 00:06:42 +00:00
James Turnbull 407a4a1916 Removed extraneous )
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:42 +00:00
Fred Lifton c90e4b1bc5 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)
2017-06-02 00:06:37 +00:00
Sven Dowideit eecd9e7003 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)
2017-06-02 00:06:36 +00:00
Fred Lifton 65c06ca59a 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)
2017-06-02 00:06:33 +00:00
Fred Lifton 90d2156bc6 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)
2017-06-02 00:06:33 +00:00
Sven Dowideit 621e17a267 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)
2017-06-02 00:06:33 +00:00
Victor Vieux 4fc06d1790 update go import path and libcontainer
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2017-06-02 00:06:32 +00:00
SvenDowideit 6f03f597ad I'm going to wish I didn't do this
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:30 +00:00
SvenDowideit dd0cd23fd7 blindly make all uses of e\.?g\.? into e.g.,
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:30 +00:00
AJ Bowen 3a348dab9b 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)
2017-06-02 00:06:29 +00:00
James Turnbull a8f2402b87 Minor fixups to the Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:27 +00:00
SvenDowideit 93ee19119b 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)
2017-06-02 00:06:27 +00:00
Sven Dowideit 0137184cb6 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)
2017-06-02 00:06:27 +00:00
James Turnbull d5b9bea76f Replaced all double backticks in README with singles
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:26 +00:00
James Turnbull 1e3f899705 Updated Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:26 +00:00
Sven Dowideit 742c981b37 simplify the docs branch process for now
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:25 +00:00
Sven Dowideit d39c8aea47 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: )
2017-06-02 00:06:25 +00:00
Andy Rothfusz 2be94a6d55 update links
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
2017-06-02 00:06:21 +00:00
Andy Rothfusz 2af848ac2c Update the documentation docs with new branch information.
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
2017-06-02 00:06:21 +00:00
Paul fb17f9fcab Mac OSX command for pip was incorrect 2017-06-02 00:06:19 +00:00
Sven Dowideit 2d576ea3b6 make docs is more consistent 2017-06-02 00:06:19 +00:00
Sven Dowideit 3091ba88fa change the policy wrt $ sudo docker to simplify auto-testing 2017-06-02 00:06:19 +00:00
John Feminella 01d4e98cc8 Corrects misspellings of 'Sphinx' 2017-06-02 00:06:19 +00:00
John Feminella b52c999103 Suggest users install dependencies by using requirements.txt, not manually 2017-06-02 00:06:19 +00:00
Sven Dowideit 23e91a6d7f add links to the Dockerfiles as canonical external requirements, add example of building and exposing the docs and simplify the Dockerfile for cacheability 2017-06-02 00:06:19 +00:00
Andy Rothfusz bed37d2204 Clean up level 3 headers. 2017-06-02 00:06:19 +00:00
Andy Rothfusz ce220ef43b Fix #1919 document how to edit and release docs. 2017-06-02 00:06:19 +00:00
Pascal Borreli 147b04ce2b Fixed typos 2017-06-02 00:06:19 +00:00
Thatcher Peskens 22ab3ddc8a Fixed some typo's and formatting issues in remote api documentation. 2017-06-02 00:06:19 +00:00
Thatcher 2216afb617 Some more improvements on the docs readme. Removed references to website. 2017-06-02 00:06:19 +00:00
Thatcher Peskens 9c5f4391e1 Updated docs README with instructions to preview the generated manfile, and where to get the one generated by sphinx. 2017-06-02 00:06:19 +00:00
Thatcher Peskens 77926c6033 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.
2017-06-02 00:06:19 +00:00