Skip to content

change to just links for whatsnew index#11689

Merged
eteq merged 1 commit into
astropy:mainfrom
eteq:update-whatsnew-index
Aug 17, 2021
Merged

change to just links for whatsnew index#11689
eteq merged 1 commit into
astropy:mainfrom
eteq:update-whatsnew-index

Conversation

@eteq

@eteq eteq commented May 3, 2021

Copy link
Copy Markdown
Member

This is a pretty minor thing but I noticed an inconsistency in docs/whatsnew/index.rst - it seems to be using two different linking idioms. This PR corrects the links to effectively point to the "latest" version rather than the "old" versions.

There might have been some reason we left it this way, though? I honestly can't recall (maybe even I thought it was important? 🤷) Maybe @bsipocz has some insight on this? (as the last editor of that page)

@github-actions github-actions Bot added the Docs label May 3, 2021
@bsipocz

bsipocz commented May 3, 2021

Copy link
Copy Markdown
Member

The diversion is when we finally introduced to not have all the what's news (as they started to have broken, and unfixable links in them), and linking with numbers for versions before the change was no possible. So, overall I think would not work, you should certainly double-check all the links in the RTD rendering.

@eteq

eteq commented May 3, 2021

Copy link
Copy Markdown
Member Author

Ohhh, I gotcha, thanks @bsipocz !

@bsipocz

bsipocz commented May 3, 2021

Copy link
Copy Markdown
Member

One more thing: whatsnew/4.2 content has to be deleted and linked to the released version, similarly to the other versions. And it has to be backported to the release branch

@bsipocz

bsipocz commented May 3, 2021

Copy link
Copy Markdown
Member

OK, so having one more look into it, the linking should be the other way around. Only the most recent one should have not a hard-wired link, all the rest should be an orphaned page, and a link to the released version with that version number.

Apparently, 4.2 hasn't been cleaned up in the 4.3 cycle.

@pllim pllim added the Release label May 3, 2021
@pllim pllim added this to the v4.3 milestone May 3, 2021
pllim
pllim previously requested changes May 3, 2021

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, I agree with @bsipocz . This is a step backward. Should be the other way around, I think.

@eteq

eteq commented Jun 18, 2021

Copy link
Copy Markdown
Member Author

Note I elected to not fix this for 4.3rc1 since it seemed more important to get the RC out the door, but leaving in milestoned 4.3 because I am still hoping to get this in as a doc fix for the release.

@eteq eteq mentioned this pull request Jul 13, 2021
16 tasks
@eteq

eteq commented Jul 13, 2021

Copy link
Copy Markdown
Member Author

Alright I corrected this. But it should wait on being merged until after the 4.3 RTD page is generated.

@pllim

pllim commented Jul 26, 2021

Copy link
Copy Markdown
Member

I think the commits should be squashed.

@pllim pllim dismissed their stale review July 26, 2021 14:50

Addressed

@eteq eteq force-pushed the update-whatsnew-index branch from 6deda58 to 789c41e Compare July 26, 2021 15:01
@eteq

eteq commented Jul 26, 2021

Copy link
Copy Markdown
Member Author

squashed

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. I will approve to remove merge block and leave it to you, @eteq , to decide when the time is right for merging. Thanks!

@pllim

pllim commented Jul 26, 2021

Copy link
Copy Markdown
Member

p.s. I don't think this can be backported. So I am updating the labels and milestone.

@pllim pllim modified the milestones: v4.3, v5.0 Jul 26, 2021
@eteq eteq force-pushed the update-whatsnew-index branch from 789c41e to 9493687 Compare July 26, 2021 22:07
@eteq eteq merged commit b7db880 into astropy:main Aug 17, 2021
@eteq eteq deleted the update-whatsnew-index branch August 17, 2021 18:22
@pllim

pllim commented Aug 17, 2021

Copy link
Copy Markdown
Member

For the record, this broke RTD. The CI for it did fail. Should not have merged with that failure. FYI.

.../docs/whatsnew/4.2.rst: WARNING: document isn't included in any toctree
.../docs/whatsnew/4.3.rst: WARNING: document isn't included in any toctree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants