* Docs: update sample application initiation in venv
Until now, readers would install 'Flask' on their main system
python environment, freeze their entire packages, and grep only
the 'Flask' package! So they would be missing all the other
dependencies in their requirements file.
With this commit, a better practice is followed. First, create a
clean virtual environment, then install 'Flask' and freeze
everything into the requirements file.
Also, I recommend using 'python3 -m pip freeze' instead of 'pip3
freeze' while in the virtual environment. This is because
sometimes hidden quirks of 'pip' will ignore the actiavted
environment and freeze the entire python packages in the
system (e.g. in ArchLinux).
* Docs: update python sample testing application
In the previous commit, I forgot to update the 'Test the
application' section so that the users activate the virtual
environment first.
This commit fixes that.
Co-authored-by: Stefan Scherer <stefan.scherer@docker.com>
There is no logic in that Flask app to save widgets, so I reworded the two sentences that referenced saving widgets.
There are two routes:
1. `/widgets` -> Gets all the rows from the `widgets` table
2. `/initdb` -> Drops the DB/Table and rebuilds them from scratch
* 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>
* python indetation 4 spaces acording to PEP8
* docker-compose example networking explanation
exlpain why no need to connect the 2 containers to a network
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
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>
* 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
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.
- 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>
- 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
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>
- 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>
- 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>
* 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>
* 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
Pedram Ashofteh-Ardakani
Craig Osterhout
Micael Jarniac
Akira Aso
Daniel Schroeder
Daniel Schroeder
ming
meni181818
CrazyMax
Keagan Roos
craig-osterhout
gaoagong
CrazyMax
Roberto Villarreal
Justin Chadwell
Allie Sadler
Grant Mitchell
Pedro Pessoa
Jerae Duffin
Usha Mandya
Sebastiaan van Stijn
Usha Mandya
Giuseppe De Gaetano
Dovydas Lozys
Nicholas Rasi
OusSaidi
OGUNSOLA USMAN ADEBAYO
Valerii Makhniuk
Jake Levirne
Stefan Scherer
Dan Bámíkíyá
Rayed Bin Wahed
HARIHARAN E
vuurball
Taemin Park
Kyle Martin
Santiago Rodriguez
David Humphrey
Sebastiaan van Stijn
Ralph Bodenner
seungwonleee
Kenneth Caple
Stan Manilov
Wajdi Al-Hawari
Masahiro Aoki
arvind-007
shayan-7
kurama
DJ Adams
dodsonmg
Aaryan Porwal