Skip to content

x/website: add link to cmd/golangorg/README.md from README.md #39687

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
Closed
julieqiu opened this issue Jun 18, 2020 · 1 comment
Closed

x/website: add link to cmd/golangorg/README.md from README.md #39687

julieqiu opened this issue Jun 18, 2020 · 1 comment
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@julieqiu
Copy link
Member

julieqiu commented Jun 18, 2020 •
edited by dmitshur
Loading

It's not immediately clear from the top-level README how to run cmd/golangorg, but this is explained in cmd/golangorg/README.md.

We should add a short description and link to cmd/golangorg/README.md from the top-level README.

See https://github.com/golang/build#overview as an example.

/cc @dmitshur @AceroM
@gopherbot gopherbot added this to the Unreleased milestone Jun 18, 2020
@julieqiu julieqiu added the NeedsFix The path to resolution is known, but the work has not been done. label Jun 18, 2020
@dmitshur dmitshur added the Documentation Issues describing a change to documentation. label Jun 18, 2020
@dmitshur dmitshur changed the title x/website: add link to cmd/golangorg/README.md from README.md and CONTRIBUTING.md x/website: add link to cmd/golangorg/README.md from README.md Aug 27, 2020
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/251121 mentions this issue: website: update README.md

@golang golang locked and limited conversation to collaborators Aug 28, 2021
@rsc rsc unassigned AceroM Jun 23, 2022
MK825 added a commit to MK825/website that referenced this issue Oct 18, 2022
@MK825
website: update README.md
e17fd4c 
Update README.md to explain how to make basic content changes,
with a link to the content/README.md for advanced things.

Fixes golang/go#39687.

Change-Id: Ie2a603422f4c7057ffdab71f434b60f53e99a828
Reviewed-on: https://go-review.googlesource.com/c/website/+/251121
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@dmitshur @julieqiu @gopherbot @AceroM