Commit Graph

50 Commits

Author SHA1 Message Date
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
Sebastiaan van Stijn a045d5d100
Merge pull request #13727 from califken/patch-2
Update run-containers.md
2021-11-11 15:02:18 +01: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
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 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
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 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
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
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
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
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
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 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
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
unknown 383a04a6cf fix typo 2021-05-06 13:02:18 -05:00
AJ Bovaird 3964047c04 Fix YAML indentation for nodejs CI/CD guide 2021-04-27 10:50:45 -04: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 a463d3290f
use primary-btn instead of outline-btn
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-13 16:34:01 +02:00
Anh Tran 8c5aeac4a3
doc: clarify the description of NodeJS guides 2021-03-24 23:59:53 +07:00
Mark Goho 42076c9a36
fix username for tagged image in github actions
the username is hardcoded, but should use the same secret from the first step
2021-03-16 14:10:19 -04:00
Usha Mandya f30f4d5541
Merge pull request #12370 from t3hami/patch-2
Add .dockerignore file step in nodejs example
2021-03-11 15:15:18 +00:00
Usha Mandya 4bf9708018
Merge pull request #12355 from david-szabo97/patch-2
Node.js guide: Fix syntax highlighting
2021-03-05 14:31:12 +00:00
Muhammad Tehami ea3b63e774 Add .dockerignore file step in nodejs example 2021-02-23 13:52:57 +05:00
Dávid Szabó e122a11c55
Fix syntax highlighting 2021-02-18 22:26:49 +01:00
Dávid Szabó 5add977c71
Fix syntax highlighting 2021-02-18 22:23:46 +01:00
Dávid Szabó a5c80cc3ee
Fix volume mismatch 2021-02-18 22:10:46 +01:00
Usha Mandya 62fb3155ca
Merge pull request #12218 from matt-continuousdelta/patch-2
Clarify instructions
2021-02-17 14:05:37 +00:00
Matthew McClure f7a25beac4
Reduce inconsistencies with previous step
Adapt instructions so that the process follows more naturally from the previous step.
2021-02-01 15:12:41 -05:00
Matthew McClure 1be59f2fcc
Update develop.md
* Eliminate unnecessary URL path parts.
* Preserve mock endpoints because it's unnecessary to remove them.
2021-02-01 13:33:38 -05:00
Matthew McClure 6bfb54843c
Clarify instructions
* Eliminate unnecessary port change.
* Clarify code change and breakpoint location.
2021-01-31 19:31:41 -05:00
Usha Mandya 4b828eeaed Update links and remove extra spaces
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-29 17:09:03 +00:00
Usha Mandya 3f3d506be4 Fix metadata in Nodejs docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-26 16:04:49 +00:00
Usha Mandya 5ec3a64fa2
Minor update 2021-01-25 19:21:22 +00:00
Norah H e7085f77be
Update develop.md
Remove duplicated instructions in the nodemon installation step and add an instruction for npm install command.
2021-01-23 09:52:46 +09:00
Usha Mandya 92b50927ea Add steps to start app in debug mode
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-19 10:50:28 +00:00
Usha Mandya 958dea68c0 Add step to install Mocha test framework
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-18 18:44:16 +00:00
Usha Mandya d9fa2c32de Add missing steps on editing the json file
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-18 15:55:23 +00:00
Usha Mandya 7b070a40e2 Fix review comments from Stefan
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-18 15:23:45 +00:00
Usha Mandya ba395bed07 Add reference architecture docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-18 12:07:55 +00:00