Eric Windisch and Tibor Vass
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 and Tibor Vass
229fa7b7b9
Add a missing definite article
...
Signed-off-by: Michael West <mwest@mdsol.com >
2017-06-02 00:06:52 +00:00
Michael West and Tibor Vass
443da2a625
Add man pages generation instructions.
...
Signed-off-by: Michael West <mwest@mdsol.com >
2017-06-02 00:06:52 +00:00
Mary Anthony and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
fb17f9fcab
Mac OSX command for pip was incorrect
2017-06-02 00:06:19 +00:00
Sven Dowideit and Tibor Vass
2d576ea3b6
make docs is more consistent
2017-06-02 00:06:19 +00:00
Sven Dowideit and Tibor Vass
3091ba88fa
change the policy wrt $ sudo docker to simplify auto-testing
2017-06-02 00:06:19 +00:00
John Feminella and Tibor Vass
01d4e98cc8
Corrects misspellings of 'Sphinx'
2017-06-02 00:06:19 +00:00
John Feminella and Tibor Vass
b52c999103
Suggest users install dependencies by using requirements.txt, not manually
2017-06-02 00:06:19 +00:00
Sven Dowideit and Tibor Vass
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 and Tibor Vass
bed37d2204
Clean up level 3 headers.
2017-06-02 00:06:19 +00:00
Andy Rothfusz and Tibor Vass
ce220ef43b
Fix #1919 document how to edit and release docs.
2017-06-02 00:06:19 +00:00
Pascal Borreli and Tibor Vass
147b04ce2b
Fixed typos
2017-06-02 00:06:19 +00:00
Thatcher Peskens and Tibor Vass
22ab3ddc8a
Fixed some typo's and formatting issues in remote api documentation.
2017-06-02 00:06:19 +00:00
Thatcher and Tibor Vass
2216afb617
Some more improvements on the docs readme. Removed references to website.
2017-06-02 00:06:19 +00:00
Thatcher Peskens and Tibor Vass
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 and Tibor Vass
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 and Tibor Vass
74428120af
Make style consistent
2017-06-02 00:06:19 +00:00
Daniel Gasienica and Tibor Vass
3c035fa508
Add Mac OS X instructions for doc tools
2017-06-02 00:06:19 +00:00
Daniel Gasienica and Tibor Vass
99dfa4e7e8
Add make server command to preview docs
2017-06-02 00:06:18 +00:00
Thatcher Peskens and Tibor Vass
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 and Tibor Vass
f4399fe403
Added code and color for 'note' and updated the hello world note.
2017-06-02 00:06:18 +00:00
Thatcher Peskens and Tibor Vass
8a39a45f05
Improved README
2017-06-02 00:06:18 +00:00