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

x/website: https://go.dev/ref/ produces weird directory listing #53243

Closed
willfaught opened this issue Jun 5, 2022 · 6 comments
Closed

x/website: https://go.dev/ref/ produces weird directory listing #53243

willfaught opened this issue Jun 5, 2022 · 6 comments
Assignees
@hyangah
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. website
Milestone
website/backlog

Comments

@willfaught
Copy link
Contributor

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

N/A?

Does this issue reproduce with the latest release?

N/A? It's observable now.

What operating system and processor architecture are you using (go env)?

N/A? Observed with Safari 15.4 (17613.1.17.1.13) on macOS Monterey 12.3.1 (21E258) on an iMac (Retina 5K, 27-inch, 2017).

What did you do?

I navigated to https://go.dev/ref/.

What did you expect to see?

Some kind of summary of the available reference material, including links to the language spec and memory model.

What did you see instead?

Some weird directory-like listing that has a link to module documentation (good), a link to some default template (bad), no links to the language spec or memory model (bad), and a link to the root page (which it calls "..", which is fine, I guess, but not very web-y) (fine).

Screen Shot 2022-06-05 at 12 00 36 PM
@gopherbot gopherbot added this to the Unreleased milestone Jun 5, 2022
@willfaught
Copy link
Contributor Author

willfaught commented Jun 5, 2022 •
edited

Most of the default questions aren't applicable to the website. Perhaps add a separate website issue template?

@cherrymui cherrymui added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Jun 6, 2022
@cherrymui
Copy link
Member

cc @dmitshur

@dmitshur
Copy link
Contributor

dmitshur commented Jun 6, 2022 •
edited

https://go.dev/ref (no trailing slash) redirects to https://go.dev/doc/#references. I suspect this issue can be resolved by making https://go.dev/ref/ do the same.

@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. labels Jun 6, 2022
@willfaught
Copy link
Contributor Author

Unrelated, but why not actually move ref/* stuff under doc/ if it's going to be listed on doc/? The old paths could just redirect.

@suzmue suzmue modified the milestones: Unreleased, website/later Jun 16, 2022
@gopherbot
Copy link

Change https://go.dev/cl/413914 mentions this issue: _content/ref: specify redirect for /ref and /ref/ using /ref/index.md

@hyangah
Copy link
Contributor

hyangah commented Jun 24, 2022

The reference docs served from /ref/* paths are either in GOROOT/doc (go_mem.html, go_spec.html) or in x/website/_content/ref (mod.md). None of them are from x/website/_content/doc directory. Given that they are somewhat special (spec!) and serving paths are different from other docs, I think it's better to keep ref/mod.md in ref and minimize change.

In cl/413914, I added /ref/index.md and that helped avoid an old issue that prevented setting redirect for /ref/.

@golang golang locked and limited conversation to collaborators Jun 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@hyangah hyangah

Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. website
Projects
None yet
Milestone
website/backlog
Development

No branches or pull requests
6 participants
@willfaught @dmitshur @hyangah @suzmue @gopherbot @cherrymui