Replace non-functional TOC directive with explanation where to look#39901
Merged
potiuk merged 1 commit intoapache:mainfrom May 28, 2024
Merged
Replace non-functional TOC directive with explanation where to look#39901potiuk merged 1 commit intoapache:mainfrom
potiuk merged 1 commit intoapache:mainfrom
Conversation
potiuk
requested review from
Taragolis,
jedcunningham,
jscheffl and
pankajkoti
and removed request for
ashb and
jedcunningham
potiuk
force-pushed
the
replace-toc-rst-with-explanation
branch
from
dbb5504 to
c2d8373
Compare
GitHub stopped rendering .. contents:: :local: in their UI and instead opt for expandable table of content that can be shown by clicking an "index" button at the top-right of the page. It's really nice when you know it but it's not easily discoverable. Seems that this is a deliberate choice and there is no going back, so best approach we can do is to explain it to the users by replacing the index with explanation where to look for it. More details here: github/markup#1798
potiuk
force-pushed
the
replace-toc-rst-with-explanation
branch
from
c2d8373 to
2a0d58c
Compare
Member
Author
|
This is the best I think we can do (unless someone has a better idea): Before: (see
After:
|
Taragolis
approved these changes
May 28, 2024
fdemiane
pushed a commit
to fdemiane/airflow
that referenced
this pull request
Jun 6, 2024
…pache#39901) GitHub stopped rendering .. contents:: :local: in their UI and instead opt for expandable table of content that can be shown by clicking an "index" button at the top-right of the page. It's really nice when you know it but it's not easily discoverable. Seems that this is a deliberate choice and there is no going back, so best approach we can do is to explain it to the users by replacing the index with explanation where to look for it. More details here: github/markup#1798
romsharon98
pushed a commit
to romsharon98/airflow
that referenced
this pull request
Jul 26, 2024
…pache#39901) GitHub stopped rendering .. contents:: :local: in their UI and instead opt for expandable table of content that can be shown by clicking an "index" button at the top-right of the page. It's really nice when you know it but it's not easily discoverable. Seems that this is a deliberate choice and there is no going back, so best approach we can do is to explain it to the users by replacing the index with explanation where to look for it. More details here: github/markup#1798
ephraimbuddy
added
changelog:skip
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
GitHub stopped rendering .. contents:: :local: in their UI and instead opt for expandable table of content that can be shown by clicking an "index" button at the top-right of the page. It's really nice when you know it but it's not easily discoverable. Seems that this is a deliberate choice and there is no going back, so best approach we can do is to explain it to the users by replacing the index with explanation where to look for it.
More details here: github/markup#1798
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.