Commit Graph

107 Commits

Author SHA1 Message Date
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
jerae-duffin 0c958d9807
Revised Content (#13031)
Updated content

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-06-23 15:32:46 +01:00
Micael Jarniac b07bc8ff73
Fix typos
Fixes #13053
2021-06-23 10:43:43 -03:00
Jay Xu 20b74088f4
Wrong HTTP Method type
`curl localhost:5000` is GET request, but in doc it says POST request
2021-06-19 21:24:49 -07:00
Usha Mandya edbe0b6951 Add a note of acknowledgment
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-06-14 16:05:18 +01:00
Oliver Frolovs 902646428b
Add first half of Getting Started for Golang (#12168)
Add Golang get started guide

Signed-off-by: Oliver Frolovs <oliver@frolovs.me>
2021-06-14 13:28:14 +01:00
Makoto Oda a6aeb2c34b
Update develop.md (#12951)
`e` missed
2021-06-11 11:21:02 +01:00