Commit Graph

53 Commits

Author SHA1 Message Date
1a8787e1e6 Add a missing definite article
Signed-off-by: Michael West <mwest@mdsol.com>
Upstream-commit: b4905859d55cf756d3855c1deddb68a9509bdab4
Component: engine
2015-03-27 23:35:37 -04:00
93a82de971 Add man pages generation instructions.
Signed-off-by: Michael West <mwest@mdsol.com>
Upstream-commit: f7d75cc08a6ebdc50ea9b7473342fdf6e22dc848
Component: engine
2015-03-27 23:35:13 -04:00
e1ebdbecb2 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: fdbec264111ac20b06cdd9b885fe47415a6495e4
Component: engine
2015-03-22 11:55:32 -07:00
1211b3d022 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: 200123b317cd1bad052d3c503278d03d712e4812
Component: engine
2015-03-16 18:27:59 -06:00
ef927156e0 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: d1dc24e5db27f7a77458898ceb6be27a9acf01da
Component: engine
2015-03-06 14:05:26 -08:00
ba30fcef2a Clean up explanation of doc branches.
Signed-off-by: Peter Salvatore <peter@psftw.com>
Upstream-commit: 74b050bd0cfa897c0ef2fa50e26725af3c29a65e
Component: engine
2015-02-12 17:02:56 -05:00
1cdd0ecffc 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: df3933621372e6f974801717cbb9fe3846efbfd6
Component: engine
2015-02-06 13:45:10 +11:00
7eb5278658 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: 1b2032c82e344b918578ce2de3618597e36fd7d6
Component: engine
2015-01-19 14:23:39 +10:00
4d06ba471c 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: cfaffd1ad26cf64330b87d0f99a883215b4c5a3e
Component: engine
2014-12-30 12:58:56 +10:00
912c56d931 add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: fbb9223b1adc16834768acaa7a5776697825deb2
Component: engine
2014-12-16 14:46:25 +10:00
3b1609f4c6 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: 6d560e197ccde8f1d711ad8260cf399b078c404d
Component: engine
2014-12-04 16:10:55 +10:00
b8254843c6 Removed extraneous )
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: ec8c53228a409dc3af45e5e25798bec84c4d0515
Component: engine
2014-11-25 10:38:16 -05:00
6261aec6ba 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: 461d33eeb0fe1058c9fcea39124c2d1f9e141765
Component: engine
2014-10-29 16:43:58 -07:00
22879cb40f 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: 3d2f10e28ae6aa278aca4403d2e3b55cc8071022
Component: engine
2014-10-13 17:06:18 +10:00
da01801fe3 Merge pull request #7890 from fredlf/docs-cherry-pick-update-process
Changes to Sven's cherry pick process
Upstream-commit: 03fdc7d2c183948d2415ba1fc19b8678b59d9e7a
Component: engine
2014-09-05 09:58:18 +10:00
d94ba95b52 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: b23daef3ec9fdecc6b7bcc1e3a657eccf1f5f399
Component: engine
2014-09-04 13:32:16 -07:00
cda308f68d 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: 23cf3f74072290f2de0e57d87af3236d44e0b039
Component: engine
2014-09-02 17:44:36 -07:00
987f07dd0b 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: ead942156cadb0ef329379a52f1c42d7693a2dea
Component: engine
2014-09-01 11:32:52 +10:00
6ae4c9014c update go import path and libcontainer
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: b3ee9ac74e171e00f14027e39278013629e681b8
Component: engine
2014-07-24 22:19:50 +00:00
c8806a50df 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: fa29b1f062d25c1a8ca62f02b9cc7533df4c7449
Component: engine
2014-07-03 10:31:56 +10:00
413eaeb715 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: fde10cf87b9f0df6d8aa8683721a6f9d71dda516
Component: engine
2014-07-01 09:55:19 +10:00
288f2b5878 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: be9dcbbef5961357117448976411be155daac019
Component: engine
2014-06-15 01:18:11 +02:00
3cdf280b45 Minor fixups to the Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: a50a46048b8853ddfdac6f000ece86f95229dfea
Component: engine
2014-05-14 20:14:06 +02:00
40fe9434ea 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: 195f3a3f42ac8894ade9e3dbf8f02945781b6ace
Component: engine
2014-05-14 10:22:55 +10:00
1d1a0132b4 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: 46755dfc1aa30a418a11dc8e352c600ef365b969
Component: engine
2014-05-05 22:18:12 +10:00
fdb0b2b56e Replaced all double backticks in README with singles
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 723d314f097fe7b1e15f27c1d6f05794b6c5f411
Component: engine
2014-04-26 10:12:09 -04:00
7eb9afe4a1 Updated Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 7744f63159cee9cfa5d9e9307e5c29a4f589837f
Component: engine
2014-04-26 08:10:19 -04:00
03781d62bc simplify the docs branch process for now
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 65fb2e77eb8c5fdb419a94058f7b4630c00871af
Component: engine
2014-04-17 11:11:32 +10:00
0bb55ea3f4 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: 936a03bfddb24cd45f5f12c20a961bf2ae6ede93
Component: engine
2014-04-16 00:02:10 +00:00
98d4bbe0f6 update links
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
Upstream-commit: 196702fbf9905426e590c0dbcb6101e72c62aac6
Component: engine
2014-02-19 10:32:43 -08:00
83c5ea4b47 Update the documentation docs with new branch information.
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
Upstream-commit: 05c692d64ec9cabe6c16385300405406ebe63f40
Component: engine
2014-02-18 19:21:12 -08:00
5d674e11a2 Mac OSX command for pip was incorrect
Upstream-commit: f3816ee024fe66a207381832bfc97ea123ec72ed
Component: engine
2014-01-02 09:52:07 +13:00
0675a87be6 make docs is more consistent
Upstream-commit: 27646c445951b47a728675764d7ef2b198436156
Component: engine
2013-12-11 10:14:56 +10:00
46d11941b1 change the policy wrt $ sudo docker to simplify auto-testing
Upstream-commit: 13da09d22bcae553cb11b5f906d3c260db571b7d
Component: engine
2013-12-07 07:23:53 +10:00
88286721b0 Merge pull request #2836 from fj/topic/spinx⇒sphinx
Corrects misspellings of 'Sphinx'
Upstream-commit: ac70e296dbc55a60bd8d6fce7b1fb4a260a91fb1
Component: engine
2013-11-25 13:40:26 -08:00
51f543bb50 Corrects misspellings of 'Sphinx'
Upstream-commit: 1cce9f25b2866883b3f1c784ea642df4e69ca6bd
Component: engine
2013-11-23 16:21:27 -05:00
800614c9ba Suggest users install dependencies by using requirements.txt, not manually
Upstream-commit: f1b3e278b964fca4884dca80ffbe79c0e82a85ca
Component: engine
2013-11-23 15:53:50 -05:00
5d5ae2293c 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: e47f9984f8a2a250c980dd9325f6ac24a55093ed
Component: engine
2013-10-29 12:58:58 +10:00
fcf658a6b5 Clean up level 3 headers.
Upstream-commit: a1fc8e17a79818977375d5e97a1afdc5f2d2fca8
Component: engine
2013-10-21 14:03:09 -07:00
6c0068a0fa Fix #1919 document how to edit and release docs.
Upstream-commit: cd455ca6fa3a899153880a7b95b9d07762b4c97c
Component: engine
2013-10-15 15:52:21 -07:00
efc4a51c0c Fixed typos
Upstream-commit: 9b2a5964fc2067014f24e26bd2f99873751ebdc3
Component: engine
2013-08-12 18:53:06 +01:00
46b7e044d5 Fixed some typo's and formatting issues in remote api documentation.
Upstream-commit: ff6b6f2ce1f51c38b00d1a70376182645b4a0c85
Component: engine
2013-08-05 15:55:40 -07:00
9fb9438668 Some more improvements on the docs readme. Removed references to website.
Upstream-commit: ad3b091d535cde5544ec3c11da4cf8d9b278a325
Component: engine
2013-07-31 13:59:56 -07:00
0a6a10bae5 Updated docs README with instructions to preview the generated manfile, and where to get the one generated by sphinx.
Upstream-commit: 26229d78f2b77592ab6761a4ffce38ab7d859f3b
Component: engine
2013-07-31 13:44:10 -07:00
2ad5267228 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: f4b63d9eeaddae6cb15775bea13ec4bca6e115da
Component: engine
2013-07-25 17:19:58 -07:00
4902d73b72 Make style consistent
Upstream-commit: 01ce63aacdd975130244f4be70bc90736e85d457
Component: engine
2013-06-01 21:26:58 -07:00
fef5363d7d Add Mac OS X instructions for doc tools
Upstream-commit: 3ca9c11110ff5068fd453a3e8aa0b39ee26d363c
Component: engine
2013-06-01 21:26:18 -07:00
76d5aac68b Add make server command to preview docs
Upstream-commit: b4df0b17afef027e88f0536cbfc9518e04f62eec
Component: engine
2013-06-01 21:25:51 -07:00
6ebdfb5b76 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: 0d929d13d360bbcbb2e524d44253a5f405cd041f
Component: engine
2013-05-06 17:41:51 -07:00
318f58e654 Added code and color for 'note' and updated the hello world note.
Upstream-commit: 2832ea0cfeb8eb69cf42db5ec0a115300e1383b9
Component: engine
2013-04-08 20:10:47 -07:00