Commit Graph

26 Commits

Author SHA1 Message Date
John Bampton b3efa5a257
docs(whitespace): standardize `CMD` example commands (#17033) 2023-04-06 08:56:38 -07:00
Craig Osterhout dd1f3331eb
update node version (#16758) 2023-02-22 08:10:59 -08:00
David Karlsson bad2be0b64
build: tidy 'develop' section in guides (#16196)
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2022-11-23 16:53:04 +01:00
CrazyMax ba8ae8535f
build: context page
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-11-07 11:15:30 +01:00
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
CrazyMax 561118ec5b
rename docs repository
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-29 11:07:53 +02: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
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 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
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
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 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
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
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
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
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 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