Improve Slack join instructions for better readability #1641
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
cert-manager-prow
bot
added
dco-signoff: no
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
ThatsIvan
force-pushed
the
ivanmanzi/improve-contributing-readme-md
branch
from
b411cdc to
cdeed81
Compare
cert-manager-prow
bot
added
dco-signoff: yes
SgtCoDFish
requested changes
Feb 6, 2025
content/docs/contributing/README.md
Outdated
| @@ -60,9 +60,15 @@ before the meeting. The meeting chair will try to get to everything that was on | |||
| We try to record these meetings and put them on YouTube so they can be checked later – if you don't want to appear on video please keep | |||
| your camera off! | |||
|
|
|||
| ## Slack | |||
| ## Slack Community | |||
There was a problem hiding this comment.
suggestion: Changing this heading changes the link; I often link people to https://cert-manager.io/docs/contributing/#slack and so changing the link would be a "breaking" change.
Could we leave the heading as it is, and add a comment explaining that we don't want it to change?
Suggested change
| ## Slack Community | |
| ## Slack | |
| {/* NOTE: We share the link to this heading quite often in various places including slide decks, documentation and meeting notes. Please ensure that the `#slack` link is preserved! */} |
There was a problem hiding this comment.
This is completed @SgtCoDFish , kindly review again.
cert-manager-prow
bot
added
dco-signoff: no
ThatsIvan
force-pushed
the
ivanmanzi/improve-contributing-readme-md
branch
from
e64f790 to
daa3f8e
Compare
SgtCoDFish
reviewed
Feb 6, 2025
content/docs/contributing/README.md
Outdated
| @@ -60,9 +60,16 @@ before the meeting. The meeting chair will try to get to everything that was on | |||
| We try to record these meetings and put them on YouTube so they can be checked later – if you don't want to appear on video please keep | |||
| your camera off! | |||
|
|
|||
| [comment]: <> (Changing this heading will break the reference link at https://cert-manager.io/docs/contributing/#slack, so avoid modifying it.) | |||
There was a problem hiding this comment.
Adding comments in these docs is a bit weird; there's a guide here: https://github.com/cert-manager/website/?tab=readme-ov-file#task-adding-a-comment-in-documentation
ThatsIvan
force-pushed
the
ivanmanzi/improve-contributing-readme-md
branch
from
4c1b0f3 to
84ae72d
Compare
Signed-off-by: ThatsIvan <ivanmanzix@gmail.com>
Signed-off-by: ThatsIvan <ivanmanzix@gmail.com>
Signed-off-by: ThatsIvan <ivanmanzix@gmail.com>
Signed-off-by: ThatsIvan <ivanmanzix@gmail.com>
ThatsIvan
force-pushed
the
ivanmanzi/improve-contributing-readme-md
branch
from
84ae72d to
350d3ac
Compare
cert-manager-prow
bot
added
dco-signoff: yes
SgtCoDFish
approved these changes
Feb 6, 2025
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: SgtCoDFish The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
cert-manager-prow
bot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates the Slack section of the documentation to clarify the process for joining the cert-manager Slack channels. The previous wording was potentially misleading, as users must first join the Kubernetes Slack workspace before they can access the cert-manager-specific channels. The updated text provides step-by-step guidance and includes a link to request an invitation to Kubernetes Slack, making the process clearer for new members who want to contribute.