Commit Graph

65 Commits

Author SHA1 Message Date
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
7c11f5dee8 Replace utils.CheckLocalDns with bytes.Contains line
Since RemoveLocalDns patch will  remove all localhost entries
from resolv.conf we no longer need anything more then
!bytes.Contains(resolvConf, []byte("nameserver")

To check for no nameserver entry in dns config.

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: a297d6ab8c08a13503fd004ec1ad7ee9e23bd22a
Component: engine
2014-09-29 06:37:31 -04:00
fb8fce0378 Fix quoting of TESTFLAGS in devenvironment.md
Copy and pasting the example should now work, rather than TESTFLAGS being silently ignored.
Upstream-commit: 7aa88a4ff66aa0c256dc15e5e5a4ddda34ed0f46
Component: engine
2014-09-24 13:30:39 -04:00
ee05b11eb0 The correct option for go test is -test.run not -run
Upstream-commit: 2a7770a712758e9d5071cedd8e44352953bdef72
Component: engine
2014-09-03 19:06:25 +02: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
26c642c4fd Do not build using sudo on Mac OS X
Building using sudo fails on Mac OS X, but is necessary on Linux.

See https://groups.google.com/d/topic/docker-dev/1EW_pfA1t9o/discussion for discussion.

Docker-DCO-1.1-Signed-off-by: Glyn Normington <gnormington@gopivotal.com> (github: glyn)
Upstream-commit: 1c05ddd645c50102321274ec7595c8b62dd71335
Component: engine
2014-06-16 14:39:48 +01:00
907fa6b5fd Update devenvironment.md
`git clone` should use `https` URL.
Upstream-commit: 6799d14cb8cb9986d4a38473cddd009b96e717c8
Component: engine
2014-05-04 17:52:48 +01:00
3db0ad0993 Improve code/comment/output markings & display consistency
This PR aims to increase the consistency across the docs for
code blocks and code/comment/output markings.

Rule followed here is "what's visible on the screen should be reflected"

Issue:

 - Docs had various code blocks showing: comments, commands & outputs.
 - All three of these items were inconsistently marked.

Some examples as to how this PR aims to introduce improvements:

1. Removed `> ` from in front of the "outputs". Eg,
`    > REPOSITORY                 TAG       ID              CREATED` replaced with:
`    REPOSITORY                 TAG       ID              CREATED`.

2. Introduced `$` for commands. Eg,
`    sudo chkconfig docker on` replaced with:
`    $ sudo chkconfig docker on`

3. Comments:
`    > # ` replaced with:
`    # `.

> Please note:
> Due to a vast amount of items reviewed and changed for this PR, there
> might be some individually incorrect replacements OR patterns of incorrect
> replacements. This PR needs to be reviewed and if there is anything missing,
> it should be improved or amended.

Closes:
https://github.com/dotcloud/docker/issues/5286

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: f87a97f7df838742a602f1984f4552b803e3f92d
Component: engine
2014-05-01 17:52:01 +03:00
549ce4c50e remove rst/sphinx documentation
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: adf04681b4bd7293675b77b2397d87a5361b383b
Component: engine
2014-05-01 15:31:58 +10:00
772ac62a9b Docs auto-conversion fixes and MD marking and structure improvements.
- Remove redundant chars and all errors caused by RST->MD conversion.
   e.g. [/#, /\, \<, />, etc.]
 - Fix broken inter-document links
 - Fix outbound links no-longer active or changed
 - Fix lists
 - Fix code blocks
 - Correct apostrophes
 - Replace redundant inline note marks for code with code marks
 - Fix broken image links
 - Remove non-functional title links
 - Correct broken cross-docs links
 - Improve readability

Note: This PR does not try to fix/amend:

 - Grammatical errors
 - Lexical errors
 - Linguistic-logic errors etc.

It just aims to fix main structural or conversion errors to serve as
a base for further amendments that will cover others including but
not limited to those mentioned above.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)

Update:

 - Fix backtick issues

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: c932667cd26f00bb64ddf0c1a7c7de3ac95aa4be
Component: engine
2014-04-24 22:19:32 +10:00
c565574306 Mark notes and warnings, fix broken link renderings within.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 7935850005b775e0cd1a99f9bab1b8cd53784c3a
Component: engine
2014-04-18 23:31:38 +03:00
c4684e29f0 now, with shiney markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ac999a9cb2b0976e021aeb8825bb051df6bd0976
Component: engine
2014-04-16 11:04:14 +10:00
8d072a85fc Docs: add some example log lines that indicate a lack of memory when running the test suite
Docker-DCO-1.1-Signed-off-by: Jean-Baptiste Barth <jeanbaptiste.barth@gmail.com> (github: jbbarth)
Upstream-commit: 26845ef1ae97be3904b2fd85fa06f9a97ccee67c
Component: engine
2014-04-12 02:09:06 +00:00
f820af7110 help contributors be more productive
certainly saved me time after I found this in hack/make.sh :)

Docker-DCO-1.1-Signed-off-by: Tim Ruffles <oi@truffles.me.uk> (github: github_handle)
Upstream-commit: 9c4799b7e7627b21f2748458e46d697c3ee4981e
Component: engine
2014-02-24 23:07:40 +00:00
2cf8cc3b3a Remove Vagrantfile and remove it from all docs
This removes the Vagrantfile and updates the documentation to remove
the steps which explain how to install Docker in a VM via Vagrant.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 67d55860a52bec8b1a1327355b4f27674ec912aa
Component: engine
2014-02-22 03:25:32 +02:00
3648d21c65 tell the reader that they need git and make for this tutorial
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: d9f215eb2a48e6e836af9cc4015c73f17dc5be9e
Component: engine
2014-02-12 16:30:18 +10:00
2756066cbe Fix minor sphinx warning
Upstream-commit: 81d112cb7fc19e4919f9916c08d8409c74aa117a
Component: engine
2013-12-17 10:38:55 -07:00
641d703cbd Small typo fixes
Upstream-commit: f26a9d456ca267b0346077b98fc447b99319d8b9
Component: engine
2013-12-12 01:23:16 -08:00
ef604cf7d9 Merge pull request #3161 from SvenDowideit/make-replace-docker-binary-note-more-obvious
associate swapping the built docker binary with building the binary, rather than a note in building the docs
Upstream-commit: 6cf8ec606ee6826c65efe4275cd819002bacb9a5
Component: engine
2013-12-11 14:04:34 -08:00
baafd9623d associate swapping the built docker binary with building the binary, rather than a note in building the docs
Upstream-commit: be137350018608bf4a1fd01ce956f166c39988c4
Component: engine
2013-12-11 11:12:11 +10:00
0675a87be6 make docs is more consistent
Upstream-commit: 27646c445951b47a728675764d7ef2b198436156
Component: engine
2013-12-11 10:14:56 +10:00
9a46759761 use the Makefile in the dev environment documentation - its way less typing, and fewer typing mistakes
Upstream-commit: e9bf971e69800f1189dd240d95972f5f0dcc3bec
Component: engine
2013-12-05 21:48:35 +10:00
08ddb7c17c Merge pull request #2526 from metalivedev/2074-AddKnownIssues
Add Known Issue
Upstream-commit: 67b0b97a8f17c67e5599f4566c8a9e1a5bb401fe
Component: engine
2013-11-08 12:14:04 -08:00
938714910e Add known issues. Fix build warnings.
Upstream-commit: 5a9adfe9fb5bc988185ef41ca637fbeee73e947c
Component: engine
2013-11-01 16:06:46 -07:00
5e4f415366 Refactor HostConfig and escape apparmor confinement
Upstream-commit: 31638ab2ad2a5380d447780f05f7aa078c9421f5
Component: engine
2013-11-01 13:55:19 -07:00
ce829b0604 Merge pull request #2274 from peterbraden/2137-docs
Re #2137 Note about vagrant dns in the test documentation
Upstream-commit: bdd12bb7037d3e34cf294adafc6cabaf12f7cc77
Component: engine
2013-10-30 16:32:35 -07: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
71320cc1e8 Re #2137 Note about vagrant dns in the test documentation
Upstream-commit: 3db381bf086215ff9d29cf55cb55d7fa086f990d
Component: engine
2013-10-17 13:38:39 -07:00
955c1f64b4 tell the new developer how they can replace the real docker binary with the one they've been hacking on (#2142)
Upstream-commit: d91bf33df3d48ec9a1f2d460433ce719ede1a6f7
Component: engine
2013-10-11 08:47:32 +10:00
f1871e0df3 Updated the section about extracting the binary
Upstream-commit: 3cf4b2c7c1729635170dd92f83461c9662d126e4
Component: engine
2013-09-20 10:00:30 +10:00
eb6c475efd Updated the section about extracting the binary
Upstream-commit: d70cbbf1fc33f2291a686537ba5b57913809e586
Component: engine
2013-09-20 09:58:12 +10:00
35bc3934c6 Updated the section about extracting the binary
Upstream-commit: b7e7104e9293c0fd35bdb03d7f0cd00e7a90d615
Component: engine
2013-09-20 09:49:20 +10:00
cf28050cad Updated the dev environment document
Upstream-commit: 4054f31471dbb97e3786120baaa863e3a05e7c1a
Component: engine
2013-09-18 14:18:05 +10:00
83b27f0110 Further updates to the dev environment document
Upstream-commit: 76a07371c5ceda160f1491a4f6e060dda2f45242
Component: engine
2013-09-18 14:18:05 +10:00
1482328d42 Further updates to the dev environment document
Upstream-commit: 5d364fda3cc4f947487d6782e585d1391782817b
Component: engine
2013-09-18 14:18:05 +10:00
e537c86df2 Update the devenvironment document
Upstream-commit: 28311f61be35bf92557542ae6ffb4aab11539720
Component: engine
2013-09-18 14:18:05 +10:00
db02ee1460 Updated the dev environment document
Upstream-commit: 70b731735c810d9e179837eb8761a44fbe98f391
Component: engine
2013-09-18 12:41:12 +10:00
42f39a5ca8 Further updates to the dev environment document
Upstream-commit: 5797e7e34e3366c9fe65e9d4743014a25910b197
Component: engine
2013-09-17 21:05:55 +10:00
df7599c3c7 Further updates to the dev environment document
Upstream-commit: 089a60c2cfcd17287dc79c5c632eb4775003c3e4
Component: engine
2013-09-17 21:02:57 +10:00
16f525621b Update the devenvironment document
Upstream-commit: a99a8386fdf71c5cc0f7757a5b4ef2747f0d1ea8
Component: engine
2013-09-17 19:29:13 +10:00
fd36c14020 Fix #1517, #1521 by adding sudo to examples and installation.
Upstream-commit: d4eab77f0c604e10f63519833dc25fbd5a3419bf
Component: engine
2013-08-14 16:21:36 -07:00
efc4a51c0c Fixed typos
Upstream-commit: 9b2a5964fc2067014f24e26bd2f99873751ebdc3
Component: engine
2013-08-12 18:53:06 +01:00
885edf50ba Fixed a couple of minor syntax errors.
Upstream-commit: 32663bf431b64d1169509bacba36e3c90e131b44
Component: engine
2013-07-20 21:27:55 -04:00
63618e51b5 Fix outdated docs explaining how to setup a dev environment. Building docker with docker ftw
Upstream-commit: a839b36e55da231874b312ee184c9d8164460bdc
Component: engine
2013-07-09 16:48:16 -07:00
d233a440c6 Merge branch 'master' into remove_bsdtar
Conflicts:
	docs/sources/contributing/devenvironment.rst
Upstream-commit: abf85b25085b52e19f774dc30bd87527b3295f2a
Component: engine
2013-06-14 14:34:30 -07:00
1d89b8f78f add aufs-tools package to dev env docs page
Upstream-commit: fb7eaf67d1c01eea28fcbed61d6d8abd8117c965
Component: engine
2013-06-14 21:41:12 +03:00
f73437e29d Update docs
Upstream-commit: 79fe864d9a117193b4dce8b7fe156a55bbadcce6
Component: engine
2013-06-14 10:58:16 -07:00
032df4df5a Merge pull request #840 from dhrp/just-fixed-some-links
Fixed some links. Closes #839 #838 #835
Upstream-commit: 5712e37437ffcfbb17d75f7f9c977bf1d4013042
Component: engine
2013-06-10 13:51:43 -07:00