golang/go

x/website/_content/doc/tutorial: unnecessary cd into home directory

Open

#66,497 opened on Mar 22, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wantedwebsite

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Issue

The tutorial suggests making the project folder in the home directory:- image Ex:- https://go.dev/doc/tutorial/getting-started , https://go.dev/doc/tutorial/getting-started

Which can be misleading and can convey that a go project must be created in the home directory.

Suggested fix

  1. Remove the step
  2. Mark the step as optional
  3. Add a note implying the project directory can be made in other directories as well

Contributor guide

Research direction
Locate the tutorial files in the x/website/ content/doc/tutorial/ directory, then edit the markdown to either remove the cd step or mark it as optional.
Tech stack
go
Domain
content
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80