Commit Graph

155 Commits

Author SHA1 Message Date
Kickimanjaro
0d5c87d584 #12800
This initially looked like a typo (reported in #12800) but I believe it is actually just an extra word that can be removed.
2021-05-05 10:43:19 -06:00
Usha Mandya
f47930bcb0 Merge branch 'master' into build-secrets 2021-04-23 10:26:25 +01:00
Sebastiaan van Stijn
e22984f7d4 use Dockerfile "syntax" directive in examples
BuildKit allows using alternative Dockerfile syntaxes to introduce new features
without having to update Docker itself. The general recommendation is to always
specify a "syntax" directive in a Dockerfile, so that (if needed) older versions
of Docker can download the correct syntax to build the Dockerfile.

This updates our examples to include a syntax directive, to make users more familiar
with these directives, and to illustrate best-pracitces in our documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-20 10:19:12 +02:00
Sebastiaan van Stijn
f4ed09424b move compose examples to the samples directory
Unifying all "examples" in this directory; some of these should still be
reviewed and/or removed in favor of examples from "awesome compose"

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:38:56 +02:00
Sebastiaan van Stijn
e4455a5f8f Add / update some redirects for old URLs, and move old engine examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:38:52 +02:00
Chris Crone
fc7a472277 develop.build: Update secrets example
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2021-04-16 19:29:21 +02:00
Itamar Turner-Trauring
bce3cbf09d Stop telling people not to install security updates 2021-03-25 08:41:05 -04:00
Mossroy
b968f80922 Fix minor typo in example of documentation
I suppose the directory where to extract postgresql should be called postgres instead of postgress
2021-03-12 22:01:48 +01:00
Jesper Rønn-Jensen
2ef942f78b Add compatibility notes for docker multistage build (#12379)
* add compatibility notes for docker multistage build

add note that multistage docker builds are supported from version 17.05 and upwards.

(this is according to the release notes https://docs.docker.com/engine/release-notes/17.05/)

* Minor update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-05 14:56:50 +00:00
Usha Mandya
332f38eb12 Update develop/index.md
Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-02-25 12:17:06 +00:00
Muhammad Tehami
97a48fa9b4 Add links to Docker Engine SDK and the HTTP API 2021-02-23 17:30:11 +05:00
Henare Degan
8889138246 Fix typo in Dockerfile Best Practices ENV section
The example below this change shows that the ENV value can be dumped so I think this was a typo saying that the ENV value can't be dumped.
2021-02-10 14:14:40 +11:00
Sebastiaan van Stijn
340fe84d1b Update links to mkimage example scripts
Link to the contrib directory instead of individual scripts.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-05 14:55:58 +01:00
lemonez
5b6824c105 Update dev-best-practices.md
minor typo fix
2020-11-06 07:52:32 -08:00
Usha Mandya
3fd2cb1e10 Merge pull request #11480 from nathanl/patch-1
Note that `ssh-add` may be needed
2020-11-04 15:17:50 +00:00
Sebastiaan van Stijn
2ce808edc0 Remove references to obsolete engine versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-26 15:45:07 +01:00
Sebastiaan van Stijn
c119ed174e Use https:// for links and examples
Found these using `http://[^lp10\*`<][^o]` (to exclude "localhost" and IP-addresses)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:09:11 +02:00
Sebastiaan van Stijn
393d3f6566 Add rel="noopener" to external links
See https://web.dev/external-anchors-use-rel-noopener/

Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-12 13:09:30 +02:00
Nathan Long
349d17db12 Note that ssh-add may be needed 2020-10-05 15:33:03 -04:00
Duncan Ogilvie
62cf39dfbf Make first apt example follow all best practices
This is a bit of a draft, but I came across this issue in the documentation. When I searched for `docker apt-get` I found this page and copy-pasted the first example, but then I remembered it's best practice to install all packages at once and after that clear the `lists` to minimize the image size. Putting the example with all best practices first might help newer docker users to produce smaller images.
2020-09-28 22:55:35 +02:00
Sebastiaan van Stijn
f6adc80d9a remove examples for ENV key value without '='
The `ENV key value` form can be ambiguous, for example, the following defines
a single env-variable (`ONE`) with value `"TWO= THREE=world"`:

    ENV ONE TWO= THREE=world

While we cannot deprecate/remove that syntax (as it would break existing
Dockerfiles), we should reduce exposure of the format in our examples.

Also updating some code-blocks that were missing language-hints

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-09-23 15:16:35 +02:00
Saleem Abu Shelbayeh
5108496f84 Fix [Ruby on Rails app on Docker lab] link
Added the word "lap" inside the link tag.
2020-08-30 11:42:32 +03:00
Sebastiaan van Stijn
3e767a72b3 Update architectures in matrix (#10999)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-06-16 14:39:07 +01:00
Shakti Singh
f71cf9b992 Updates on the page hyperlinks (#10931)
* Updates on the page hyperlinks 

updates statements in both 
## Develop new apps on Docker
## Learn about language-specific app development with Docker

* Minor style edits

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2020-06-02 09:00:35 +01:00
Sebastiaan van Stijn
9cd60d843e develop: use relative markdown links
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:15 +02:00
Usha Mandya
4b1b6826a4 Merge pull request #10659 from ajay143444/patch-2
changed check to check-in
2020-04-22 10:38:28 +00:00
ajay143444
2e9d7cf5aa removed hyphen from check in 2020-04-22 15:49:50 +05:30
ajay143444
21a633cd59 changed lots more to lots of (#10664)
changed lots more to lots of
2020-04-22 09:10:24 +01:00
ajay143444
7bd9befce0 contained by changed to contained in (#10663)
contained by changed to contained in
2020-04-22 09:09:22 +01:00
ajay143444
60132211b6 Update develop/dev-best-practices.md
commted your suggestion

Co-Authored-By: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2020-04-20 16:12:58 +05:30
ajay143444
5f8cedaf5a changed check to check-in
corrected line 84 by changing check to check-in
2020-04-20 15:25:10 +05:30
Sebastiaan van Stijn
331554f4b3 Fix various links that were generating URLs with .md (#10548)
* Fix incorrect links in compose section

there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* engine/swarm: update links

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Fix various broken links

There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-01 12:05:50 +01:00
Sebastiaan van Stijn
43bba8317c Develop with Docker: remove nesting, and some restructuring
- Remove the "Develop your apps on Docker" section, as there
  was only a single section.
- Shorten titles in the navigation: the page itself still
  has the full title. Some titles also didn't match the
  title on the page.
- Changed "Docker build enhancements for 18.09" to
  "Build images with BuildKit" to help discovery of the
  BuildKit back-end.
- Some minor (Markdown) touch-ups of the BuildKit topic.
- Moved "Create a base image" lower in the navigation,
  because it's an advanced topic that most users won't
  be using (generally, using the official base images
  from Docker Hub would be recommended).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-19 11:55:22 +01:00
Sebastiaan van Stijn
14bbe621e5 Update markdown language hints to work with "rouge"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:49:51 +01:00
Usha Mandya
1566e01673 Moved topics under engine/api/ 2020-02-21 16:44:41 +00:00
Usha Mandya
36aba6a7c6 Get started docs updates (#10218)
* Update Get started docs

* update part-1, add redirects

* draft updates to part 2 and 3

* tidy up the orchestration topics

* update examples, and other minor edits

* address Stefan's review comments

* moved orchestration to a new node

* fix Ben's review comments

* add email verification step

* Emphasize the CTA in part 3
2020-02-14 17:24:50 +00:00
Shivang Goswami
94879d3ac2 In line 657,it should be can't instead of can
"Can" in place of "can't" is making the meaning of the paragraph confusing.In additional,it is in contrast with the example provided.
2019-12-24 22:33:28 +05:30
Jeff Anderson
eeea0d586a Call out FROM can take a previous stage (#9566)
The included example could be improved with a more concrete use case, but illustrates the capability as is.
2019-12-09 10:48:45 +00:00
Dawn-Docker
3c54d2ff9c Update toc (#9819) 2019-11-08 08:13:40 -08:00
lena-larionova
54ca6a523b Fixing glossary links (#9812)
Signed-off-by: Lena Larionova <lena.larionova@docker.com>
2019-11-06 11:00:13 -08:00
Renan Roggia
09c8a2d726 Update references to the get-started pages (#9651) 2019-10-16 11:27:18 -07:00
jamesche75
17a24ef257 Updated bullet on FROM instruction. (#7275)
If you try and build an image without a FROM instruction in the Dockerfile, the Docker daemon will throw an error. You must include "FROM scratch" to build a base image.
2019-09-06 11:57:27 +01:00
Jose J. Escobar
3279c447b6 Update dockerfile_best-practices.md (#9335)
Just two typos
2019-09-02 18:50:06 +01:00
AlberTo de Prezzo
7ca2ef679e Update index.md (#9078)
"io" needs to be imported, in order to avoid " undefined: io" error. 
(go version: go1.12.5 linux/amd64)

P.S: import statements are reordered/formatted (gofmt).

Cheers
2019-08-19 15:23:58 +01:00
Pierre-Antoine Couaillier
c60d3ca8d1 add some details on limitation of buildkit with UCP (#9118)
add details on limitation of buildkit with UCP
2019-08-19 15:14:04 +01:00
Victor Bordo
e72bfc468d Add missing dependency to Run a container example (#9153)
The `io` library needs to be imported for the example to compile successfully.
2019-08-16 11:47:56 +01:00
linchiwei123
041a31c3b8 fix COPY failed (#9234)
since README.md listed in https://github.com/docker-library/hello-world/blob/master/.dockerignore , you will get COPY failed without this change.
2019-08-16 11:32:39 +01:00
Alex Goodman
07360ef578 remove depricated methods from go sdk examples (#8689)
* remove depricated methods from go sdk examples

* use negotiate client option; handle import & tty review comment
2019-07-23 08:56:00 -07:00
ollypom
c39ba281fd Synced Docs Public Master with Docs Private Master 2019-07-19 11:02:28 +00:00
Wojtek Wrona
d5293c2191 Update dockerfile_best-practices.md (#7336)
LGTM, thanks!
2019-07-12 14:08:46 -07:00