Commit Graph

213 Commits

Author SHA1 Message Date
Craig Osterhout 8b5cf33e2f
fix formatting for issue 15365 (#15368) 2022-08-12 10:01:05 +01:00
Craig Osterhout 4231acfd40
[ENGDOCS-864] Update java language-specific guide (#15269)
* Updated java guide

* Update language/java/develop.md

Co-authored-by: Guillaume Lours <guillaume@lours.me>

* Update language/java/develop.md

Co-authored-by: Guillaume Lours <guillaume@lours.me>

* moved multi-stage Dockerfile to develop section

Co-authored-by: Guillaume Lours <guillaume@lours.me>
2022-08-03 13:55:57 -07:00
CrazyMax 02d195dcb7
Merge pull request #15276 from crazy-max/rm-absolute-links
remove most of absolute urls
2022-08-03 12:30:39 +02:00
CrazyMax 09c9f51bcf
remove most of absolute urls
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-08-03 11:50:33 +02:00
Roberto Villarreal ad96551b60
Fix spelling mistake in golang docs (#15305) 2022-08-03 10:15:28 +01:00
Justin Chadwell ad45d2d936 lint: tidy spaces inside spans 2022-07-28 11:27:10 +01:00
Justin Chadwell 749d27b40d lint: tidy up consistent header styles 2022-07-28 11:27:10 +01:00
Allie Sadler ab0dee78a2
merge dashboard and user manual (#15145)
* merge dashboard and user manual

* fix broken links

* fix broken links

* fix broken links

* updates

* fixes
2022-07-19 15:40:54 +01:00
CrazyMax 2482f8ce04
Remove unneeded <br> HTML tags
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-07-14 19:54:47 +02:00
Grant Mitchell 00cc2961b7
added what file type the github actions is
I added this as it might be confusing for some people who dont write in yaml every day to know what file it is. it is best to explicitly state what file type it is
2022-06-23 13:57:51 -07:00
Pedro Pessoa e22fab1ab0
style inconsistency in `--publish flag`
the code part is just `--publish`, so "flag" should be normal text, as in other parts of the text
2022-06-16 15:14:01 -03:00
Jerae Duffin 7f9b8c7392 fixed typo 2022-05-12 15:46:52 -05:00
Usha Mandya 5c5ba79b74 Remove the request new guide issue link
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-04-26 23:46:13 +01:00
Sebastiaan van Stijn cc62b154b8
language/java: fix code-hint to use the correct language
This block now shows java code, so changing the code-hint to make
sure it's highlighted correctly.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-04-12 11:56:01 +02:00
Usha Mandya 3e55e4ab63
Merge pull request #14352 from giudega/updateTests
removed reference to code line
2022-04-08 11:25:28 +01:00
Giuseppe De Gaetano 60bd96d506
Merge branch 'docker:master' into master 2022-03-27 23:24:03 +02:00
Dovydas Lozys 5edae78bdd
fixes typos 2022-03-25 17:58:00 +00:00
Usha Mandya c82853feb5
Merge pull request #14402 from OusSaidi/patch-1
Fix small typo
2022-03-23 09:49:40 +00:00
Nicholas Rasi a3b576c0a8
Fix Small Typo 2022-03-19 18:38:49 +01:00
OusSaidi c8d0d5c8f8
Fix small typo 2022-03-17 16:41:46 +01:00
Giuseppe De Gaetano 03cd16c2df removed reference to code line 2022-03-06 23:51:45 +01:00
Giuseppe De Gaetano 64ffe96450 removed reference to code line number 2022-03-06 19:55:48 +01:00
Usha Mandya 8d2682cac0
Merge pull request #13898 from humphd/patch-1
Update run-tests.md
2022-02-25 11:49:44 +00:00
Usha Mandya 1c402e7fbf
Merge pull request #14272 from ValeriiMakhniuk/patch-1
add link to volumes.md docs
2022-02-25 11:04:47 +00:00
Usha Mandya 9c63f89aac
Update language/nodejs/develop.md 2022-02-25 11:01:06 +00:00
OGUNSOLA USMAN ADEBAYO f5ed385f5b
Update develop.md (#14025)
* Update develop.md

- provided more clarity to the structure of the mongo database connection string used as CONNECTIONSTRING environment variable to run the docker image in the sample node.js project.

* Update develop.md
2022-02-24 14:15:46 +00:00
Usha Mandya 3d884a7138
Merge pull request #14235 from danBamikiya/configure-ci/cd-reorder
Ammend PAT setup section in Go language guide
2022-02-24 14:15:03 +00:00
Valerii Makhniuk 6617ca3c95
add link to volumes.md docs 2022-02-16 20:32:31 +03:00
Jake Levirne 3d9c6aff71
Minor typo - fixed case 2022-02-13 17:10:21 -05:00
Stefan Scherer bcc2a90f52
Use host port 8000 to avoid conflicts on Monterey
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2022-02-09 13:05:34 +01:00
Dan Bámíkíyá 89ded65463
Ammend PAT setup section in Go language guide 2022-02-06 17:20:23 +01:00
Rayed Bin Wahed 122645e717
Update develop.md
Accidental subject-verb agreement error. Made the verb singular to agree with the singular subject Docker.
2022-02-02 12:00:38 +08:00
HARIHARAN E 65ddb87fd0
modify yoda_notes to notes at line 85 2022-01-21 12:49:03 +05:30
vuurball a93c040494
Update develop.md
typo fix
2022-01-16 14:30:06 +02:00
Usha Mandya 64cd649161
Merge pull request #14061 from bigsky-033/patch-1
Fix typo on PGDATABASE environment variable
2022-01-14 14:31:52 +05:30
Taemin Park 3d775401b8
Fix typo on PGDATABASE environment variable
Add colon on PGDATABASE
2021-12-31 17:05:18 +09:00
Kyle Martin 57b5a647ad
Very minor style update to included sample Python
Inconsequential and trivial change to ensure code in tutorial is consistently styled.
2021-12-27 19:20:04 -07:00
Santiago Rodriguez 2dd8f20546
small typo 2021-12-25 05:19:08 -04:00
David Humphrey 929daf72d6
Update run-tests.md
Fixed a couple of typos.
2021-11-26 21:32:20 -05:00
Dan Bamikiya 2452b40e9a
Remove usage of outdated `GHCR_TOKEN` (#13710)
* Remove usage of outdated GHCR_TOKEN

* Prefer {{ github.actor }} over {{ github.repository_owner }}

* Update language/java/configure-ci-cd.md with note about GITHUB_TOKEN

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update language/nodejs/configure-ci-cd.md with note about GITHUB_TOKEN

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update language/python/configure-ci-cd.md with note about GITHUB_TOKEN

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-11-26 12:38:53 +00:00
Dan Bamikiya cc5d5db7c5
Explain the use of the `COPY` command in the NodeJS example (#13711)
* Explain the use of the COPY command in nodejs example

* Format updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-11-19 12:18:37 +00:00
Usha Mandya 52d182a483
Merge pull request #13828 from rkbodenner/patch-1
Clearer purpose and contents for .dockerignore
2021-11-17 15:01:35 +00:00
Usha Mandya 57639274cd
Update build-images.md 2021-11-17 14:33:01 +00:00
Sebastiaan van Stijn a045d5d100
Merge pull request #13727 from califken/patch-2
Update run-containers.md
2021-11-11 15:02:18 +01:00
Ralph Bodenner b90deff361
Clearer purpose and contents for .dockerignore
I had to read the original paragraph a few times and search for docs on the file's purpose to understand what this step entailed. So here's another try at an explanation of what to do and why, with a hint about best practice.
2021-11-10 23:48:18 -08:00
seungwonleee 5131e29bfd Fix typo Language-specific guides / Nodejs / Run your tests 2021-11-06 02:30:41 +09:00
seungwonleee 0056623a58 Fix typo Language-specific guides / Nodejs / Run containers 2021-11-06 02:29:30 +09:00
Kenneth Caple f1242413b7
Update run-containers.md 2021-10-23 14:10:04 -07:00
Sebastiaan van Stijn d7e9ac275f
Some touch-ups in language get-started
- wrap lines in the java and golang getting started
- make the "test on the host" step in the Java getting started "optional". This
  allows users to try the tutorial without requiring them to set up a functional
  Java environment on their host. (i'm planning on making similar changes in
  the other language guides).
- use `docker <object> <action>` in some examples (but mention the corresponding
  shorthands); this may help understand the relation between the `<action>` and
  what kind of `<object>` we're acting on (tag an _image_, remove an _image_).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-10-13 16:30:58 +02:00
Usha Mandya d8a91fd44b
Merge pull request #13490 from mafreud/patch-1
Update run-containers.md
2021-10-04 10:46:59 +01:00
Usha Mandya 9a4eb3a8a6
Merge pull request #13507 from idjaw/update-docs-pip-freeze
Improves how requirements.txt is managed in Python tutorial #13506
2021-10-04 10:06:09 +01:00
Stan Manilov 3e5032813f Remove outdated sentence
The output following the sentence no longer contains what the sentence
claims.
2021-09-16 22:18:57 +03:00
Wajdi Al-Hawari a9a8311643 Improves how requirements.txt is created
- To reduce the error prone process of grabbing all Python packages in the global Python scope, the specific package is extracted and set in to the requirements.txt file
2021-09-11 16:30:23 -04:00
Masahiro Aoki 9dd353952b
Update run-containers.md 2021-09-09 13:54:54 +09:00
Sebastiaan van Stijn fbd8c365c8
language/nodejs: un-wrap JSON in example to allow copying
The JSON string was wrapped, causing the highlighter to consider it "output",
which cannot be selected/copied in "console" blocks.

This unwraps the JSON so that it can be copied.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-02 16:56:29 +02:00
Sebastiaan van Stijn 81177c8b02
fix language guides markup
- force "nowrap"
- add "col-xs-12" to fix size on smaller sizes
- remove the "component-icon" div, as it was not styled

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-02 13:53:22 +02:00
Sebastiaan van Stijn 60709ed648
Merge pull request #13423 from arvind-007/patch-1
Update build-images.md
2021-08-27 16:05:39 +02:00
Usha Mandya 2feae0d569
Merge pull request #13410 from thaJeztah/go_get_started_touchups
guides: use include for "create a Dockerfile" sections
2021-08-27 14:54:49 +01:00
arvind-007 23b029e358
Update build-images.md 2021-08-27 15:27:55 +05:30
Sebastiaan van Stijn d1fbf5c959
guides: use include for "create a Dockerfile" sections
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-25 13:42:32 +02:00
shayan-7 2b5a5618a1
Found more typos and grammar issues 2021-08-23 22:04:22 +04:30
shayan-7 6a118534ab
Fix a typo 2021-08-23 21:06:00 +04:30
Sebastiaan van Stijn 1583678203
Add missing code-hints, and minor markdown edits
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
  put in separate blocks. With the "console" code-hint, this
  is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
  numbered-list to be interrupted.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-16 12:59:23 +02:00
kurama f4655fb89e
fix: typo (#13348)
* fix: typo

* Minor style updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-08-16 11:57:31 +01:00
DJ Adams 5dd725fb4f
add explicit instruction to stop local server (#13235)
* add explicit instruction to stop local server

This relates to the [Test the application section of the Build images tutorial](https://docs.docker.com/language/nodejs/build-images/#test-the-application). 

In this section, `node server.js` is used to start the server locally. The reader is not instructed to stop the server. 

In the [Run containers](https://docs.docker.com/language/nodejs/run-containers/) tutorial that follows this one, the reader is instructed to start up the container, and try to access `http://localhost:8000/test` which is now being served from the Node.js process inside the container. However, if the local Node.js process from the `node server.js` invocation earlier, they won't see the "Failed to connect to localhost port 8000" error which they're supposed to see. 

So this modification adds an explicit instruction to the "Build containers" tutorial to stop the `node server.js` process, to avoid any potential confusion in the "Run containers" tutorial.

Great tutorials, btw!

* show what happens with Ctrl-c

add suggestions from @thaJeztah, plus the same language identifier on the triple-backtick quoted output earlier (`console`).

* Minor styling updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-08-09 11:26:37 +01:00
Sebastiaan van Stijn 74460241f8
language/python: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:20:00 +02:00
Sebastiaan van Stijn 60bb48a6a1
language/nodejs: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:19:59 +02:00
Sebastiaan van Stijn 38b629bcb2
language/java: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:19:58 +02:00
Sebastiaan van Stijn 0ceace875d
language/golang: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:19:58 +02:00
Sebastiaan van Stijn 7e9fdf93fe
language/golang: fix some broken links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 11:52:13 +02:00
Jerae Duffin 326b8efe9e updated volumes link 2021-08-05 21:58:55 -05:00
Jerae Duffin ed5cad4884 fixed broken link 2021-08-05 21:48:27 -05:00
Usha Mandya 0d5e3ecf82
Merge pull request #13266 from dodsonmg/fix_golang_release_workflow
golang: Fix username mismatch issue in tutorial GitHub workflow
2021-08-03 15:53:14 +01:00
Usha Mandya d7bd7353b3 Add K8s to the deploy app section
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-08-03 14:20:27 +01:00
dodsonmg 65587b2239 Fix username mismatch issue in GitHub workflow
Correctly handles mismatch between GitHub and Docker Hub usernames.
2021-08-01 13:46:39 +01:00
Aaryan Porwal 6531e8ef21
Update build-images.md (#12843)
* Update build-images.md

Small typos in the documentation, which may lead to confusion.

* Inspiration from node.js docs

Added documentation for why we copy `package*.json` before copying the whole directory. Checkout: https://nodejs.org/en/docs/guides/nodejs-docker-webapp/#creating-a-dockerfile. 
The node.js docs has more optimized code too (using `npm ci` instead of `npm install`) which can be used here too.

* Fixed review provided and removed some weird whitespaces
2021-07-30 13:56:05 +01:00
Usha Mandya 347073cfd2
Merge pull request #13253 from mnahinkhan/patch-2
Update configure-ci-cd.md
2021-07-30 10:16:46 +01:00
Sebastiaan van Stijn 568308c890
Merge pull request #13236 from qmacro/patch-2
be explicit about having a breakpoint-able line
2021-07-30 11:15:53 +02:00
Sebastiaan van Stijn 54ed39dd1e
fix missing stubs and TOC entries for docker compose
Also updated one link in language/golang to .md

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-07-30 10:22:35 +02:00
Nahin Khan fb0f050656
Update configure-ci-cd.md 2021-07-30 03:26:34 +03:00
Usha Mandya 86d0ee1607
Merge pull request #13221 from usha-mandya/engdocs-453
Update get started docs to use BuildKit for building images
2021-07-28 22:54:46 +01:00
Usha Mandya 5d8ed04758 Wrap lines in buildkit example
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-07-28 17:01:14 +01:00
jerae-duffin c6e5fe142d
Fixed Broken Link (#13234)
* fixed broken link

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-07-28 16:15:05 +01:00
DJ Adams 68001ae96c
be explicit about having a breakpoint-able line 2021-07-27 10:37:00 +01:00
Usha Mandya 3a7a582e4e Add buildkit example for Nodejs run tests
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-07-23 13:03:49 +01:00
Usha Mandya b1674e814e Update get started docs to use BuildKit for building images
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-07-23 12:06:18 +01:00
Usha Mandya 31109b1819
Merge pull request #13183 from andchar/patch-1
fixed path to ci.yml
2021-07-23 10:48:48 +01:00
Usha Mandya 983429aecb
Merge pull request #13181 from QKflame/patch-1
Update run-tests.md
2021-07-23 10:24:51 +01:00
Usha Mandya b0022ea68e
Fix a grammar issue (#13212)
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-07-21 16:16:18 +01:00
Usha Mandya 56ab91a3d2
Merge pull request #13179 from theBeginner86/typos_in_language_file
Typos Fixed in the run-container.md files of language folder
2021-07-21 11:35:20 +01:00
Sebastiaan van Stijn 5011f61213
Fix Dockerfile COPY/ADD examples without a trailing slash
When copying files to a destination directory, the classic builder requires
the destination to have a trailing slash (to indicate the target is a _directory_.
not a filename). BuildKit is a bit more flexible in this, and will assume the
target is a directory, but users following the example with buildkit disabled
might see an error message, e.g.:

    Sending build context to Docker daemon  3.072kB
    Step 1/2 : FROM busybox
     ---> 69593048aa3a
    Step 2/2 : COPY *.go .
    When using COPY with more than one source file, the destination must be a directory and end with a /

It doesn't hurt to be explicit, so this patch updates some examples to prevent
this.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-07-21 12:03:31 +02:00
andchar 91c021ab3e
fixed path to ci.yml 2021-07-15 08:03:07 +03:00
QKflame 16e3321138
Update run-tests.md 2021-07-14 23:47:32 +08:00
theBeginner86 7681fec4b7 Typos fixed 2021-07-14 02:01:27 +05:30
Usha Mandya fe46aa5c1f
Merge pull request #13142 from Sammeeey/patch-3
Adjusted sentence to make more clear what to do
2021-07-13 11:06:43 +01:00
Usha Mandya 1faeb961ad
Merge pull request #13138 from Sammeeey/patch-2
Add "-dev"-suffix to new image
2021-07-13 11:03:55 +01:00
theBeginner86 3831ba50c9 typo fixed 2021-07-10 11:15:30 +05:30
Sammeeey 5ece5aa899
Adjusted sentence to make more clear what to do
ihih
2021-07-07 13:41:48 +02:00
Sammeeey e52dfc1353
Add "-dev"-suffix to new image
I've added a "-dev"-suffix in the lines where we are working with the new python-docker image.
In this way we do not overwrite the previous one
2021-07-07 12:18:12 +02:00
Usha Mandya a09bef6227
Merge pull request #13034 from zhengjxu/patch-1
Wrong HTTP Method type in documentation
2021-06-24 14:03:47 +01:00