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

Add table of contents to upgrade guides #34025

Closed

Conversation

@smithandre
Copy link
Contributor

smithandre commented Oct 18, 2019

Q A
Branch? 4.4
Bug fix? no
New feature? no
Deprecations? no
Tickets NA
License MIT
Doc PR NA

Added a table of contents to the upgrade guides, which can help us find relevant upgrade information a bit faster. It's very basic and straight forward, as I don't want to add too much overhead in terms of maintaining these guides.

@nicolas-grekas nicolas-grekas added this to the next milestone Oct 18, 2019
@smithandre smithandre changed the title Upgrade guides/add table of contents Add table of contents to upgrade guides Oct 18, 2019
@nicolas-grekas nicolas-grekas modified the milestones: next, 4.4 Oct 27, 2019
Copy link
Member

nicolas-grekas left a comment

I'm not sure we should merge this: it looks nice, but it looks hard to maintaint.

UPGRADE-4.1.md Show resolved Hide resolved
@ro0NL

This comment has been minimized.

Copy link
Contributor

ro0NL commented Nov 8, 2019

there's also #32840, i'd prefer a generated ToC as well (to reduce maintenance load)

once tooling/infrastructure is in place, we could leverage e.g. https://github.com/ekalinin/github-markdown-toc

@nicolas-grekas

This comment has been minimized.

Copy link
Member

nicolas-grekas commented Nov 9, 2019

Closing as explained, thanks for proposing.

@smithandre smithandre deleted the smithandre:upgrade-guides/add-table-of-contents branch Nov 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.