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

docs: Fix broken formating and link #13661

Merged
merged 2 commits into from
Oct 21, 2020
Merged

docs: Fix broken formating and link #13661

merged 2 commits into from
Oct 21, 2020

Conversation

pchaigno
Copy link
Member

See commits for details.

The entire code block was missing in the renderd version due to a typo.

Signed-off-by: Paul Chaignon <paul@cilium.io>
We can't have a link with a replace directive (|SCM_WEB|) in the
document unless we use the link directly (i.e., not ` <>`_ or similar
alias method). As far as I understand, this is because reStructuredText
doesn't support nested inline markup [0].

0 - https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible
Signed-off-by: Paul Chaignon <paul@cilium.io>
@pchaigno pchaigno added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.8 labels Oct 21, 2020
@pchaigno pchaigno requested a review from a team as a code owner October 21, 2020 08:09
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.9.0-rc3 Oct 21, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.8.5 Oct 21, 2020
@aanm aanm merged commit 3bc4a45 into master Oct 21, 2020
@aanm aanm deleted the pr/pchaigno/fix-link-docs branch October 21, 2020 11:30
@nathanjsweet nathanjsweet mentioned this pull request Oct 22, 2020
25 tasks
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.8 in 1.8.5 Oct 22, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.9 in 1.9.0-rc3 Oct 22, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.8 to Backport done to v1.8 in 1.8.5 Oct 31, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.9 to Backport done to v1.9 in 1.9.0-rc3 Oct 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.8.5
Backport done to v1.8
1.9.0-rc3
Backport done to v1.9
Development

Successfully merging this pull request may close these issues.

None yet

5 participants