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.

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

doc: link to main entry point for modules documentation is not working and various module sections are not recognized as headers #27209

Closed
thepudds opened this issue Aug 25, 2018 · 3 comments
Closed

doc: link to main entry point for modules documentation is not working and various module sections are not recognized as headers #27209

thepudds opened this issue Aug 25, 2018 · 3 comments
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.12

Comments

@thepudds
Copy link
Contributor

Please answer these questions before submitting your issue. Thanks!

What version of Go are you using (go version)?

Go 1.11 doc at golang.org:

https://golang.org/doc/go1.11

Does this issue reproduce with the latest release?

Yes.

Issue

Clicking on the modules link in the release notes (where the text is new concept called “modules,”) does not take you to the modules documentation because the fragment identifier does not exist any longer on the go command documentation page:

https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more

If you look at the sections present in the HTML documentation at https://golang.org/cmd/go, there are various sections that are not being treated as headers (including they don't show up in the table of contents, and they are not formatted as headers in the main body of the documentation).

'Bad' sections include:

  • The go.mod file
  • Edit go.mod from tools or scripts
  • Modules, module versions, and more

Interestingly, the documentation on tip.golang.org seems to not have this issue. For example, this works:

https://tip.golang.org/cmd/go/#hdr-Modules__module_versions__and_more

Perhaps some variation or re-occurrence of #26938 or similar...
@thepudds
Copy link
Contributor Author

thepudds commented Aug 25, 2018 •
edited

This is also a 'bad' / missing section header that is present on tip.golang.org but missing at golang.org:

  • Gofmt (reformat) package sourcesGo

The 'bad' / missing section headers all seem to include at least one of (, ), or . characters, whereas the 'good' / present section headers do not have those characters.

It seems the golang.org doc might have been generated without either of these:

https://golang.org/cl/122407 // from ~2 months ago
https://golang.org/cl/129677 // from a ~week ago

Maybe Go 1.10 or some other non-recent version was used to generate the Go 1.11 golang.org doc site?

@thepudds thepudds changed the title doc: link to main entry point to modules documentation is not working and various module sections are not recognized as headers doc: link to main entry point for modules documentation is not working and various module sections are not recognized as headers Aug 25, 2018
@FiloSottile FiloSottile added the NeedsFix The path to resolution is known, but the work has not been done. label Aug 25, 2018
@FiloSottile FiloSottile modified the milestones: Go1.11.1, Go1.11 Aug 25, 2018
@FiloSottile
Copy link
Contributor

This is due to #27205.

@tklauser tklauser mentioned this issue Aug 28, 2018
Closed
@ALTree ALTree modified the milestones: Go1.11, Go1.12 Sep 22, 2018
@andybons
Copy link
Member

andybons commented Nov 9, 2018

This has since been resolved. Thanks.

@andybons andybons closed this as completed Nov 9, 2018
@golang golang locked and limited conversation to collaborators Nov 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.12
Development

No branches or pull requests
5 participants
@andybons @FiloSottile @ALTree @gopherbot @thepudds