Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
Taz03 opened this issue Mar 22, 2024 · 2 comments · May be fixed by golang/website#293
Open

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

Taz03 opened this issue Mar 22, 2024 · 2 comments · May be fixed by golang/website#293
Labels
Documentation help wanted NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. website
Milestone
website/unplanned

Comments

@Taz03
Copy link

Taz03 commented Mar 22, 2024

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
@gopherbot gopherbot added this to the Unreleased milestone Mar 22, 2024
@seankhliao seankhliao changed the title x/website: Misleading steps in go tutorials x/website/_content/doc/tutorial: unnecessary cd into home directory Mar 22, 2024
@dr2chase
Copy link
Contributor

@golang/tools-team

@dr2chase dr2chase added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Mar 25, 2024
@hyangah hyangah modified the milestones: Unreleased, website/unplanned Apr 4, 2024
@heysujal heysujal linked a pull request Jun 23, 2024 that will close this issue
Open
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/594276 mentions this issue: _content/doc/tutorial: remove the unnecessary cd into home directory instruction

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation help wanted NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. website
Projects
None yet
Milestone
website/unplanned
Development

Successfully merging a pull request may close this issue.

_content/doc/tutorial: remove the unnecessary cd into home directory instruction heysujal/website
5 participants
@dr2chase @hyangah @suzmue @gopherbot @Taz03