prakhar1989/docker-curriculum

Tutorial Confusing from the Beginning

Open

#317 opened on Nov 14, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)CSS (4,274 stars) (1,686 forks)batch import
help wantedquestion

Description

I just downloaded and installed Docker for Desktop and successfully launched it.

The tutorial says "Once you are done installing Docker, test your Docker installation by running the following:

$ docker run hello-world

Hello from Docker. This message shows that your installation appears to be working correctly. ...

Where do I do this? I try the cmd prompt and get the following message: "'$' is not recognized as an internal or external command,"

Being a bit more explicit for for a newbie would help.

Contributor guide

Tech stack
docker
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue is a documentation bug where the tutorial assumes users know to run commands in a terminal and that the '$' is a shell prompt, not part of the command. The fix should update the relevant tutorial page (likely the first chapter) to explicitly instruct users to open a command prompt or terminal window and to type only the command after the '$' symbol. The maintainer should respond to the issue and apply a small edit to clarify the instructions.