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/build/cmd/releaseschedule: no docs/README.md #59314

Closed
crisman opened this issue Mar 29, 2023 · 3 comments
Closed

x/build/cmd/releaseschedule: no docs/README.md #59314

crisman opened this issue Mar 29, 2023 · 3 comments
Labels
Builders x/build issues (builders, bots, dashboards) FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@crisman
Copy link
Contributor

crisman commented Mar 29, 2023 •
edited by dmitshur

New script for generating the SVG on the release cycle wiki page has no docs.

Would be nice if there was a least a short note on what the SVG was for and link the wiki page to update after regeneration.

https://go.dev/s/release or https://go.dev/wiki/Go-Release-Cycle
@gopherbot gopherbot added the Builders x/build issues (builders, bots, dashboards) label Mar 29, 2023
@gopherbot gopherbot added this to the Unreleased milestone Mar 29, 2023
@crisman
Copy link
Contributor Author

crisman commented Mar 29, 2023

Hello, new to x/build tooling here, does adding a package doc to cmd/releaseschedule/main.go and running update-readmes.go to get a README.md seem like the correct way to do this?

@heschi
Copy link
Contributor

heschi commented Mar 29, 2023

Yep, I think that's it. Go for it.

crisman added a commit to crisman/golang_build that referenced this issue Mar 31, 2023
@crisman
cmd/releaseschedule: basic doc and README.md
ad4058b 
"cmd/releaseschedule" had no docs and no direction on what to do with
the output. Would be better to have links to the wiki page and basic
information on what to do with the output. Helps with discoverability as
well if someone searches for information that SVG.

Add package doc with request to update wiki & links to wiki. Generate
README.md with update-readmes.go.

Fixes golang/go#59314
@crisman crisman mentioned this issue Mar 31, 2023
Closed
@gopherbot
Copy link

Change https://go.dev/cl/480975 mentions this issue: cmd/releaseschedule: basic doc and README.md

@dmitshur dmitshur added the NeedsFix The path to resolution is known, but the work has not been done. label Mar 31, 2023
@golang golang locked and limited conversation to collaborators Mar 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Builders x/build issues (builders, bots, dashboards) FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

Successfully merging a pull request may close this issue.

cmd/releaseschedule: basic doc and README.md crisman/golang_build
4 participants
@crisman @dmitshur @gopherbot @heschi