prakhar1989/docker-curriculum

Tutorial Confusing from the Beginning

Geschlossen

#317 geöffnet am 14.11.2021

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)CSS (1.686 Forks)batch import
help wantedquestion

Repository-Metriken

Stars
 (4.274 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Research-Richtung
Das Problem ist ein Dokumentationsfehler, bei dem das Tutorial davon ausgeht, dass Benutzer wissen, wie man Befehle in einem Terminal ausführt, und dass das '$' eine Shell Eingabeaufforderung ist, nicht Teil des Befehls. Die Korrektur sollte die entsprechende Tutorial Seite (wahrscheinlich das erste Kapitel) aktualisieren, um Benutzer explizit anzuweisen, ein Eingabeaufforderungs oder Terminalfenster zu öffnen und nur den Befehl nach dem '$' Symbol einzugeben. Der Maintainer sollte auf das Issue antworten und eine kleine Bearbeitung vornehmen, um die Anweisungen zu klären.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Command line basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80