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: Harmonise references to Cilium Slack #27346
Merged
Merged
Conversation
This file contains 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
We link to Cilium Slack at multiple locations in Cilium's documentation. The way we do it is far from consistent: - We usually provide a direct link to the Slack instance - ... Which, over time, resulted in at least 13 occurrences of the same URL https://cilium.herokuapp.com - Sometimes, we create an indirect link to a "_slack" target, pointing to the gettinghelp.rst page - Some other times, we use other indirect links pointing to the glossary. - At some locations, we also mention that users can get invites to the Slack instance. As far as I know, these invites are no longer necessary. Let's try to clean this up. - Create a target link in the RST epilogue in conf.py, so we can reference it from any location. - Call this link everywhere we need, using `Cilium Slack`_ in a consistent fashion. - Format most channel names as inline literals. - Improve formatting (not the content) of some paragraphs that already get updates for Slack references: rewrap, remove trailing spaces, etc. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
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.
backport/1.12
This PR represents a backport for Cilium 1.12.x of a PR that was merged to main.
backport/1.13
This PR represents a backport for Cilium 1.13.x of a PR that was merged to main.
backport/1.14
This PR represents a backport for Cilium 1.14.x of a PR that was merged to main.
labels
Aug 8, 2023
/test |
nebril
approved these changes
Aug 8, 2023
dylandreimerink
approved these changes
Aug 8, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
lambdanis
approved these changes
Aug 8, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
awesome
maintainer-s-little-helper
bot
added
the
ready-to-merge
This PR has passed all tests and received consensus from code owners to merge.
label
Aug 8, 2023
qmonnet
added
needs-backport/1.12
needs-backport/1.13
This PR / issue needs backporting to the v1.13 branch
needs-backport/1.14
This PR / issue needs backporting to the v1.14 branch
and removed
backport/1.12
This PR represents a backport for Cilium 1.12.x of a PR that was merged to main.
backport/1.13
This PR represents a backport for Cilium 1.13.x of a PR that was merged to main.
backport/1.14
This PR represents a backport for Cilium 1.14.x of a PR that was merged to main.
labels
Aug 9, 2023
YutaroHayakawa
added
backport-done/1.13
The backport for Cilium 1.13.x for this PR is done.
and removed
backport-pending/1.13
The backport for Cilium 1.13.x for this PR is in progress.
labels
Aug 17, 2023
tklauser
added
backport-pending/1.14
The backport for Cilium 1.14.x for this PR is in progress.
and removed
needs-backport/1.14
This PR / issue needs backporting to the v1.14 branch
labels
Aug 22, 2023
joestringer
added
backport-done/1.14
The backport for Cilium 1.14.x for this PR is done.
and removed
backport-pending/1.14
The backport for Cilium 1.14.x for this PR is in progress.
labels
Aug 25, 2023
joestringer
moved this from Backport pending to v1.13
to Backport done to v1.13
in 1.13.7
Aug 25, 2023
joestringer
moved this from Needs backport from main
to Backport done to v1.14
in 1.14.2
Aug 25, 2023
qmonnet
added
the
backport/author
The backport will be carried out by the author of the PR.
label
Aug 29, 2023
This was referenced Sep 9, 2023
julianwiedmann
added
backport-done/1.12
The backport for Cilium 1.12.x for this PR is done.
and removed
backport-pending/1.12
labels
Sep 11, 2023
jrajahalme
moved this from Backport pending to v1.12
to Backport done to v1.12
in 1.12.15
Oct 17, 2023
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.
backport/author
The backport will be carried out by the author of the PR.
backport-done/1.12
The backport for Cilium 1.12.x for this PR is done.
backport-done/1.13
The backport for Cilium 1.13.x for this PR is done.
backport-done/1.14
The backport for Cilium 1.14.x for this PR is done.
ready-to-merge
This PR has passed all tests and received consensus from code owners to merge.
release-note/misc
This PR makes changes that have no direct user impact.
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.
We link to Cilium Slack at multiple locations in Cilium's documentation. The way we do it is far from consistent:
_slack
target, pointing to thegettinghelp.rst
pageLet's try to clean this up.
conf.py
, so we can reference it from any location.`Cilium Slack`_
in a consistent fashion.Marking for backports because it touches the doc framework (
conf.py
,check-build.sh
).No change to technical contents from the docs.