Commit Graph

39 Commits

Author SHA1 Message Date
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
Daniel Gasienica 74428120af Make style consistent 2017-06-02 00:06:19 +00:00
Daniel Gasienica 3c035fa508 Add Mac OS X instructions for doc tools 2017-06-02 00:06:19 +00:00
Daniel Gasienica 99dfa4e7e8 Add `make server` command to preview docs 2017-06-02 00:06:18 +00:00
Thatcher Peskens 6d79cab514 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. 2017-06-02 00:06:18 +00:00
Thatcher Peskens f4399fe403 Added code and color for 'note' and updated the hello world note. 2017-06-02 00:06:18 +00:00
Thatcher Peskens 8a39a45f05 Improved README 2017-06-02 00:06:18 +00:00
Thatcher Peskens 244477e27f Merge of docker-website into the docker documentation. 2017-06-02 00:06:18 +00:00
dhrp f35a9d8098 create README.md at this place for preview. 2017-06-02 00:06:18 +00:00