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

Recover the changelog docs page link #2425

Closed
wants to merge 2 commits into from

Conversation

webknjaz
Copy link
Member

@webknjaz webknjaz commented Oct 15, 2020

Summary of changes

This change makes the changelog webpage in docs recoverable again.

It's been lost as a part of #2097

Ref #2424

Pull Request Checklist

  • Changes have tests
  • News fragment added in changelog.d. See documentation for details

@webknjaz
Copy link
Member Author

@alvyjudy any objections?

@alvyjudy
Copy link
Contributor

It must have been a negligence while organizing the files thanks for pointing it out! Yes definitely we need to stop it from being orphaned and I realize a few other files also need to be organized in the similar manner (development.rst, developer-guide.rst, releases.rst). I think it would be an even better idea to open another PR to group them altogether into a separate folder and reference it from the top level index

@webknjaz
Copy link
Member Author

@alvyjudy

I'd argue that the changelog doesn't belong to development but to the user-facing category because the end-users are those who'd be interested in seeing what the updates bring.

OTOH, the changelog is quite important so I'd say it's imperative to have in on the top level, it should be visible from the front page, right away: it's one of the things users would come back for regularly while other content is viewed when new knowledge is necessary.
Hiding it into a subcategory would've been acceptable if the shown TOC nesting level was to be deeper.

@alvyjudy
Copy link
Contributor

@webknjaz Now I see your point and agree with you. I will put history.rst back to where it was in #2426 so it won't conflict with this PR

@webknjaz webknjaz mentioned this pull request Oct 15, 2020
2 tasks
@webknjaz
Copy link
Member Author

@jaraco mind labeling this PR as hacktoberfest-accepted?

@webknjaz
Copy link
Member Author

Thanks! Superseded by #2427.

@webknjaz webknjaz closed this Oct 17, 2020
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.

None yet

3 participants