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
[feature request][docs] Make highly visible distinction between master docs and stable docs #5738
Comments
would be good to also disable google indexing of very-very-old docs: #3428 in order to not fall in the pit of opencv |
How about having urls of the form http://pytorch.org/docs/stable/... ? I would suggest that such links not redirect to http://pytorch.org/docs/0.3.whatever/..., and that such urls be the only documentation pages that google should reference. That way both users and google will always see up to date docs of the latest stable release unless they actively search for a specific version. Ideally there would also be a visible tag on each page to remind users which version is the stable version. |
Part of pytorch#5738. Warns users that they're not viewing the latest stable release docs. We should remember to delete this when cutting out 0.4.0 release docs. (we'd just delete the div in pytorch.github.io)
Part of #5738. Warns users that they're not viewing the latest stable release docs. We should remember to delete this when cutting out 0.4.0 release docs. (we'd just delete the div in pytorch.github.io)
This PR does the following: 0) Moves everything from docs/0.3.1/ to docs/stable/ 1) Redirects docs/ to docs/stable. docs/tensors.html --> docs/stable/tensor.html 2) Redirects docs/0.3.1/ to docs/stable/. docs/0.3.1/tensors.html --> docs/stable/tensors.html 3) Changes all of the redirect pages to use the same liquid template so the redirection page can be easily changed. Fixes pytorch/pytorch/#6478. Partially resolves pytorch/pytorch#5738. Test Plan: `jekyll serve` and verify the redirects from above points 1 and 2.
This PR does the following: 0) Moves everything from docs/0.3.1/ to docs/stable/ 1) Redirects docs/ to docs/stable. docs/tensors.html --> docs/stable/tensor.html 2) Redirects docs/0.3.1/ to docs/stable/. docs/0.3.1/tensors.html --> docs/stable/tensors.html 3) Changes all of the redirect pages to use the same liquid template so the redirection page can be easily changed. Fixes pytorch/pytorch/#6478. Partially resolves pytorch/pytorch#5738. Test Plan: `jekyll serve` and verify the redirects from above points 1 and 2.
Requested from here: https://discuss.pytorch.org/t/people-reading-master-docs/14847
I quote from jpeg729,
"Many, many questions on this forum come from people who have read the docs for the master branch and wonder why their code doesn’t work.
A little research reveals that the redirections are inconsistent. Maybe that is how so many people end up reading the master docs by mistake.
http://pytorch.org/docs -> http://pytorch.org/docs/0.3.1/
http://pytorch.org/docs/nn -> http://pytorch.org/docs/master/nn.html
Can I suggest that a little strategic renaming might go a long way? Namely this…
http://pytorch.org/docs/master/… -> http://pytorch.org/docs/dev/…
Can I also suggest adding to all pages of the master docs some sort of highly visible banner that says “dev version” next to a link to the docs for the latest stable version?"
The text was updated successfully, but these errors were encountered: