Skip to content

Update documentation dropdown#1

Closed
adrn wants to merge 1 commit intoeteq:release-3.1from
adrn:release-3.1
Closed

Update documentation dropdown#1
adrn wants to merge 1 commit intoeteq:release-3.1from
adrn:release-3.1

Conversation

@adrn
Copy link
Copy Markdown

@adrn adrn commented Dec 9, 2018

This updates the documentation dropdown menu for the new release.

Comment thread index.html
<li><a href="http://docs.astropy.org" target="_blank">Current Release (3.1)</a></li>
<li><a href="http://devdocs.astropy.org/" target="_blank">In Development</a></li>
<li><a href="https://astropy.readthedocs.io/en/v2.0.9/index.html" target="_blank">v2.0.9</a></li>
<li><a href="https://astropy.readthedocs.io/en/v3.0.5/index.html" target="_blank">v3.0.5</a></li>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't update this version to non LTS, but rather 2.0.10

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment below. If this is really supposed to be LTS, it should link to http://docs.astropy.org/en/lts/

Comment thread index.html
<div class="dropdown-content">
<ul>
<li><a href="http://docs.astropy.org" target="_blank">Current Release</a></li>
<li><a href="http://docs.astropy.org" target="_blank">Current Release (3.1)</a></li>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm -1 on this

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I know why, but can you explain?

@adrn
Copy link
Copy Markdown
Author

adrn commented Dec 9, 2018

IMO, we should either go all-in on putting version numbers in the dropdown, or none. I prefer having the version numbers there as a quick way for users to see what is new / old. But I know @bsipocz is going to push back and say that creates the possibility of the numbers being out of sync. If we take that philosophy, then I suggest instead removing v2.0.9 and instead having "current release", "in development", "long-term support" (and link the last one to http://docs.astropy.org/en/lts/).

@bsipocz
Copy link
Copy Markdown

bsipocz commented Dec 9, 2018

I'm all on board with removing 2.0.9 and listing LTS instead, that actually would make things super consistent as those three are the ones we support.

We've removed listing more versions just a couple of weeks ago as part of their removal from RTD in order to fix the google search results.

@eteq
Copy link
Copy Markdown
Owner

eteq commented Dec 10, 2018

I like the "words only" solution. Will implement that in astropy#286 (and close this once it's in)

eteq added a commit that referenced this pull request Dec 10, 2018
@adrn adrn closed this Dec 11, 2018
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

Successfully merging this pull request may close these issues.

3 participants