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

version information #3

Open
ccsmart opened this issue Apr 25, 2018 · 1 comment
Open

version information #3

ccsmart opened this issue Apr 25, 2018 · 1 comment

Comments

@ccsmart
Copy link
Contributor

ccsmart commented Apr 25, 2018

We currently have 4 URLs that come back on searching for "version" on docs

http://gawati.readthedocs.io/en/latest/development/version-compat.html
http://gawati.readthedocs.io/en/latest/development/version-info-v1.html
http://gawati.readthedocs.io/en/latest/development/version-info.html
http://gawati.readthedocs.io/en/latest/development/package-versions.html

while 1 is essentially an include of 1 other, it's still confusing as is, and while all are valid, it leaves the new user to feeling uncertain.

I believe version-info-v1 can be discarded ?
IMO in this case include should not be done and there should only be one file containing all versions and pointing out which is the latest prod and which is the latest dev.
All other related pages should point to that one page where needed, not include.

If agreed, can assign to me with the intention to automte updates as Jenkins task.

@kohsah
Copy link
Contributor

kohsah commented Apr 25, 2018

v1 can be deleted. About includes, they make things easier we can show the version or download information in different pages in a box.
What we can do is mark some pages for non inclusion in the search index (e.g. version-info.html) so it does not appear in search results directly. .. there is a sphinx directive for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants