Commit Graph

71 Commits

Author SHA1 Message Date
Craig Osterhout
da7b60072d [ENGDOCS-1012] Get started refresh part 1 & 2 (#15965)
* get started refresh part 1 and 2
2022-10-27 15:32:47 -07:00
CrazyMax
2bac3f3b6c build: merge dockerfile creation page in build section
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-10-25 19:46:23 +02:00
CrazyMax
271f8c3de5 build: merge build enhancements page in build section
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-10-25 19:46:23 +02:00
Craig Osterhout
ad614f1d2c [Issue 12622] Node.js guide - update example code (#15922)
* update server.js code
2022-10-20 13:32:12 -07:00
Akira Aso
eaa8a0748b Refine a paragraph of docker ps in Go and Python (#15873)
* Refine a paragraph of docker ps in Go and Python

* Fix typo in paragraphs about the docker ps command
2022-10-17 09:27:22 -07:00
Akira Aso
0d14bcb8c3 Make a paragraph about docker ps concise (#15839) 2022-10-11 09:59:32 -07:00
ming
50d76362e8 Update develop.md (#14315)
* Update develop.md

this makes it clear that it is the "volumes" that can sync local code changes to that in the container.

* Update language/nodejs/develop.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2022-09-30 12:40:59 +01:00
CrazyMax
561118ec5b rename docs repository
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-29 11:07:53 +02:00
Craig Osterhout
cf480fae08 rename branch and add note (#15378) 2022-08-23 13:43:03 -07:00
Justin Chadwell
ad45d2d936 lint: tidy spaces inside spans 2022-07-28 11:27:10 +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
Dovydas Lozys
5edae78bdd fixes typos 2022-03-25 17:58:00 +00:00
Nicholas Rasi
a3b576c0a8 Fix Small Typo 2022-03-19 18:38:49 +01: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
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
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
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