Skip to content

Commit 00cf7e2

Browse files
authored
Merge pull request #6743 from mrbobbytables/fix-links
Fix markdown links to be compatible with contributor-site
2 parents 93c5201 + 4772172 commit 00cf7e2

File tree

4 files changed

+65
-65
lines changed

4 files changed

+65
-65
lines changed

communication/slack-guidelines.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ message) one privately.
3838
The Kubernetes Slack Workspace is archived and made available when the
3939
administrators have time. There is no explicit interval.
4040

41-
[Slack Archive Download][]
41+
[Slack Archive Download]
4242

4343
### DM (Direct Message) Conversations
4444

@@ -100,7 +100,7 @@ determining if you should request a channel:
100100

101101
- The channel MUST be Kubernetes related in some way.
102102
- Related cloud native projects might be more appropriate on the
103-
[CNCF Slack][].
103+
[CNCF Slack].
104104
- The project MUST be open source.
105105
- Open Source a project BEFORE requesting a channel. We cannot accommodate
106106
every organization's open sourcing launch plans.
@@ -125,18 +125,18 @@ determining if you should request a channel:
125125
project channel is too noisy, but please don't create both at the
126126
start.
127127
- If you need private discussion areas for security-sensitive topics, a
128-
project-specific Slack or the [CNCF Slack][] may be a better fit.
128+
project-specific Slack or the [CNCF Slack] may be a better fit.
129129
- Ask in `#slack-admins` or file an issue if you're unsure It never hurts to
130130
ask.
131131

132132
## Requesting a Channel
133133

134-
Channels and User Groups are managed by [Tempelis][], a tool that enables
134+
Channels and User Groups are managed by [Tempelis], a tool that enables
135135
external management of Slack.
136136

137-
To add a channel, open a Pull Request (PR) updating the [slack-config][].
137+
To add a channel, open a Pull Request (PR) updating the [slack-config].
138138

139-
- Add the channel to 'channels.yaml' following the [Channel Documentation][]
139+
- Add the channel to 'channels.yaml' following the [Channel Documentation]
140140
- Channel names must be 21 characters or less in length, limited by Slack
141141
design.
142142
- Channels must not share the same name with a Slack user or user group.
@@ -167,7 +167,7 @@ There are two approvals needed. `/lgtm` and `/approve`. Once one moderator give
167167
and add the `/approve` command as well as `/hold cancel`, which will remove the hold on the PR.
168168
Once it is signed off and merged, the channel will be created.
169169

170-
For further information, see the [Slack Config Documentation][].
170+
For further information, see the [Slack Config Documentation].
171171

172172
### Delegating Channel Ownership
173173

@@ -177,9 +177,9 @@ Admins to sign-off on all requests and passes the responsibility to the most
177177
relevant group.
178178

179179
To delegate channel ownership - Open a Pull Request (PR) updating the
180-
[slack-config][].
180+
[slack-config].
181181

182-
- Create a sub-directory under the [slack-config][] for your sig or group.
182+
- Create a sub-directory under the [slack-config] for your sig or group.
183183
- Update restrictions.yaml with an entry targeting yaml config files in the
184184
sub-directory you created along with one or more regular expressions that
185185
match the channel names that should be delegated.
@@ -191,7 +191,7 @@ To delegate channel ownership - Open a Pull Request (PR) updating the
191191
- "^kubernetes-foo-[a-z]{1,3}$" # channel regexp - example match: kubernetes-foo-bar
192192
- "^foo-[a-zA-Z]+$" # channel regexp - example match: foo-awesomechannel
193193
```
194-
- Create an [OWNERS][] file in the sub-directory adding the appropriate
194+
- Create an [OWNERS] file in the sub-directory adding the appropriate
195195
reviewers and approvers for the desired channels.
196196
- In the directory create one or more channel configs following the Channel
197197
Documentation
@@ -211,18 +211,18 @@ For further information, see the
211211
212212
## Requesting a User Group
213213
214-
Channels and User Groups are managed by [Tempelis][], a tool that enables
214+
Channels and User Groups are managed by [Tempelis], a tool that enables
215215
external management of Slack.
216216
217-
To add a User Group, open a Pull Request (PR) updating the [slack-config][].
217+
To add a User Group, open a Pull Request (PR) updating the [slack-config].
218218
219219
- Add the users to users.yaml. **NOTE:** This must be a mapping of their
220220
GitHub ID to their Slack Member ID.
221221
- To get a person's Slack Member ID, view their profile. Then click on the
222222
"**...**" and select **Copy member ID**. It will be a 9 character string of
223223
uppercase letters and numbers (example: `U1H63D8SZ`).
224-
- Update [usergroups.yaml][] Follow the guidelines for creating a User Group
225-
in the Slack Config [User Group Documentation][].
224+
- Update [usergroups.yaml] Follow the guidelines for creating a User Group
225+
in the Slack Config [User Group Documentation].
226226
- In the PR comments, include details on the User Group and `/cc` the members
227227
you are adding so that they may sign off and accept being added to the
228228
group.
@@ -247,7 +247,7 @@ ensure everyone has a great experience.
247247
Typically approved requests include: GitHub, CNCF requests, or other
248248
tools/platforms used to aid in the management of Slack itself.
249249

250-
- Create a [GitHub Issue][] using the Slack Request template.
250+
- Create a [GitHub Issue] using the Slack Request template.
251251
- In the description, describe the request, its intended purpose and benefit
252252
to the community. Supplying links to supporting content such as a document
253253
outlining what OAuth scopes that are requested and why are **STRONGLY
@@ -263,7 +263,7 @@ discussed in Slack itself.
263263
### Admin Expectations and Guidelines
264264

265265
Admins should adhere to the general Kubernetes project
266-
[moderation guidelines][].
266+
[moderation guidelines].
267267

268268
Additionally, admins should ensure they have 2-factor auth enabled for their
269269
account and mention they are a Slack admin in the "What I do" portion of their
@@ -315,7 +315,7 @@ In general, use your best judgment.
315315
Once two Slack admins have reviewed and agreed to sponsor the channel, they will
316316
sign off on the Channel Request PR. Once merged, the channel will be created.
317317

318-
Channels managed by [Tempelis][] will automatically have default messages
318+
Channels managed by [Tempelis] will automatically have default messages
319319
pinned. For any manually-provisioned channels, such as private channels, add the
320320
below message and pin it.
321321

@@ -359,7 +359,7 @@ steps.
359359
For the reasons listed below, admins may inactivate individual Slack accounts.
360360
Due to Slack's framework, it does not allow for an account to be banned or
361361
suspended in the traditional sense, merely inactivated.
362-
See [Slack's policy on inactivated accounts][] for more information.
362+
See [Slack's policy on inactivated accounts] for more information.
363363
364364
#### Reasons to inactivate an account
365365

communication/youtube/youtube-guidelines.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ and includes all communications such as YouTube.
2121

2222
## Meeting Playlists
2323

24-
The [Kubernetes YouTube Channel][] has separate playlists for each SIG, WG, UG
24+
The [Kubernetes YouTube Channel] has separate playlists for each SIG, WG, UG
2525
meeting recordings, as well as recordings of other recurring events such as the
26-
Kubernetes [community meeting][], [Office Hours][], [Meet our Contributors][]
26+
Kubernetes [community meeting], [Office Hours], [Meet our Contributors]
2727
and others.
2828

29-
[Subprojects][], in addition to SIGs, WGs, UGs may request their own playlists
29+
[Subprojects], in addition to SIGs, WGs, UGs may request their own playlists
3030
to better target their contributors and increase general discoverability.
3131

32-
To better serve the community, [collaboration][] has been enabled to share the
32+
To better serve the community, [collaboration] has been enabled to share the
3333
management of the playlists. Anyone with the appropriate link to the particular
3434
playlist can upload videos *to that particular playlist* (links & playlists are
3535
one-to-one).
@@ -41,9 +41,9 @@ Hours, will be shared with the appropriate point(s) of contact.
4141
### Uploading Guidelines for Collaborators
4242

4343
**NOTE:** If you're using a Google Workspace account (formerly known as G Suite)
44-
you may need to [update the permissions in your YouTube settings][]. If you have
45-
any questions, reach out to the [YouTube admins][] or
46-
[SIG Contributor Experience][]. You may need to reach out to someone at your
44+
you may need to [update the permissions in your YouTube settings]. If you have
45+
any questions, reach out to the [YouTube admins] or
46+
[SIG Contributor Experience]. You may need to reach out to someone at your
4747
organization if you do not have access to Google Workspace Admin permissions.
4848

4949
**NOTE:** Both public and private steering meeting recordings should be made
@@ -103,7 +103,7 @@ our governance documents.
103103
### Moderator Expectations and Guidelines
104104

105105
Moderators should adhere to the general Kubernetes project
106-
[moderation guidelines][].
106+
[moderation guidelines].
107107

108108
Moderation responsibilities for YouTube admins is minimal and is centered around
109109
checking and removing any potential comments that would violate the
@@ -112,7 +112,7 @@ checking and removing any potential comments that would violate the
112112

113113
### Trimming and Editing Recordings
114114

115-
YouTube admins are asked to help [trim][] and [edit][] recordings that come into
115+
YouTube admins are asked to help [trim] and [edit] recordings that come into
116116
the video queue.
117117

118118
#### Examples:
@@ -149,7 +149,7 @@ the steps outlined below.
149149
you or reset it to a new one.
150150
- Kubernetes YouTube admin permissions
151151
- A correctly set up recurring meeting with a start and end time (this is
152-
important) - check [Zoom guidelines][] for more details
152+
important) - check [Zoom guidelines] for more details
153153

154154
**Steps:**
155155

@@ -166,13 +166,13 @@ the steps outlined below.
166166

167167
The following SIGs and groups are currently running splain.io:
168168

169-
- [SIG Auth][]
170-
- [SIG Contributor Experience][]
171-
- [SIG Docs][]
172-
- [SIG Network][]
173-
- [SIG Release][]
174-
- [Steering Committee][]
175-
- [WG Data Protection][]
169+
- [SIG Auth]
170+
- [SIG Contributor Experience]
171+
- [SIG Docs]
172+
- [SIG Network]
173+
- [SIG Release]
174+
- [Steering Committee]
175+
- [WG Data Protection]
176176
- The main Zoom admin account which holds Meet Our Contributors and others (if
177177
you log in to splain using this account, all of the other accounts will be
178178
logged here)
@@ -214,9 +214,9 @@ to hear from you.
214214
### Streaming Events
215215

216216
YouTube admins with a system capable of streaming may be asked to stream public
217-
Kubernetes Community events such as the weekly [Community Meeting][],
218-
[Office Hours][], [Meet our Contributors][], or other publicly streamed
219-
events. For detailed information about streaming, see our [Streaming Config][].
217+
Kubernetes Community events such as the weekly [Community Meeting],
218+
[Office Hours], [Meet our Contributors], or other publicly streamed
219+
events. For detailed information about streaming, see our [Streaming Config].
220220

221221
### Migrating Content
222222

@@ -225,7 +225,7 @@ be useful to grab content from other channels. It is currently NOT POSSIBLE to
225225
move content from one YouTube channel to another, so the content must be
226226
downloaded and then reuploaded to the Kubernetes channel.
227227

228-
1. Download [youtube-dl][], which makes it easier to bulk download videos.
228+
1. Download [youtube-dl], which makes it easier to bulk download videos.
229229
2. Download the channel or playlist with: `youtube-dl <url>`
230230
3. Clean up the filenames as they are used to generate new titles. Do this
231231
locally since it is easier than doing it per video in the YouTube web UI.

communication/zoom-guidelines.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,34 @@ description: |
55
---
66

77
Zoom is the main video communication platform for Kubernetes. It is used for
8-
running the [community meeting][], [SIG/WG meetings][], [Office Hours][],
9-
[Meet Our Contributors][] and many other Kubernetes online events. Since the Zoom
8+
running the [community meeting], [SIG/WG meetings], [Office Hours],
9+
[Meet Our Contributors] and many other Kubernetes online events. Since the Zoom
1010
meetings are open to the general public, a Zoom host or co-host has to moderate
1111
a meeting in all senses of the word, from starting and stopping the meeting to
12-
acting on [Kubernetes code of conduct][] issues.
12+
acting on [Kubernetes code of conduct] issues.
1313

1414
These guidelines are meant as a tool to help Kubernetes members manage their
1515
Zoom resources.
1616

17-
Check the main [moderation][] page for more information on other tools
17+
Check the main [moderation] page for more information on other tools
1818
and general moderation guidelines.
1919

2020

2121
## Code of conduct
2222

23-
The Kubernetes project adheres to the [Kubernetes Code of Conduct][]
23+
The Kubernetes project adheres to the [Kubernetes Code of Conduct]
2424
throughout all platforms and includes all communication mediums.
2525

2626
## Zoom license management
2727

28-
Zoom licenses are managed by the [CNCF Service Desk][] through the
29-
[Zoom Admins][] listed in the [centralized list of administrators][].
28+
Zoom licenses are managed by the [CNCF Service Desk] through the
29+
[Zoom Admins] listed in the [centralized list of administrators].
3030

3131
### Obtaining a Zoom license
3232

3333
Ensure that all SIG/WG leads, chairs, and any other necessary trusted owners
3434
have access to the `k-sig-<foo>[email protected]` account as described in
35-
the [sig creation procedure][]. Once done, contact one of the [Zoom Admins][] to
35+
the [sig creation procedure]. Once done, contact one of the [Zoom Admins] to
3636
obtain a Zoom license.
3737

3838
## Setting up your meeting and moderation
@@ -42,9 +42,9 @@ and others who would intentionally attempt to disrupt your Zoom call.
4242

4343
To create a meeting with **moderation** enabled, ensure the following:
4444

45-
- Have the [latest version][] of the Zoom client installed.
45+
- Have the [latest version] of the Zoom client installed.
4646
- Be logged in as the leads account associated with the meeting **OR** use the
47-
[host key][] to "claim host".
47+
[host key] to "claim host".
4848
- Configure a meeting setup through the "Meeting" menu in the leads Zoom
4949
account. **NOTE:** Do **NOT** use the "Personal Meeting ID". This will
5050
create an "ad-hoc" meeting that is time-bounded and without moderation
@@ -64,7 +64,7 @@ After the meeting has started:
6464
If you're dealing with a troll or bad actor:
6565

6666
- Put the troll or bad actor on **hold**. The participant will be put into a
67-
[waiting room][] and will not be able to participate in the call until the
67+
[waiting room] and will not be able to participate in the call until the
6868
host removes the hold.
6969
- **NOTE:** Depending on your client version this will be called "**Put in
7070
Waiting Room**" instead of on **hold**.
@@ -75,47 +75,47 @@ If you're dealing with a troll or bad actor:
7575
remove.
7676
- After an action has been taken, use the **lock meeting** feature so that no
7777
one else can come into the meeting. If that fails, end the call
78-
immediately, and contact the [Zoom Admins][] to report the issue.
78+
immediately, and contact the [Zoom Admins] to report the issue.
7979

8080
**NOTE:** You can find these actions when clicking on the **more** or **"..."**
8181
options after scrolling over the participants name/information.
8282

8383
Hosts **must** be comfortable with how to use these moderation tools and the
8484
Zoom settings in general. Make sure whoever is running your meeting is equipped
8585
with the right knowledge and skills. If you have any questions or concerns,
86-
reach out to the [Zoom Admins][] and they will be able to provide further
86+
reach out to the [Zoom Admins] and they will be able to provide further
8787
guidance and training.
8888

8989
#### Related moderation documentation
9090

91-
- Zoom has [documentation on how to use their moderation tools][].
91+
- Zoom has [documentation on how to use their moderation tools].
9292
- Members of the _leads@_ group have access to an extensive
93-
[best practices doc][] with screenshots going over the community Zoom best
93+
[best practices doc] with screenshots going over the community Zoom best
9494
practices.
9595

9696
### Escalating and Reporting a Problem
9797

9898
Issues that cannot be handled via normal moderation, or with the assistance of
99-
the [Zoom Admins][] should be escalated to the Kubernetes
100-
[Code of Conduct Committee][] at [email protected].
99+
the [Zoom Admins] should be escalated to the Kubernetes
100+
[Code of Conduct Committee] at [email protected].
101101

102102
To contact the admin group in Slack, ping `@zoom-admins` in the `#sig-contribex`
103103
Slack channel.
104104

105105
## Meeting recordings
106106

107107
Chairs and TLs are responsible for posting all update meetings to their playlist
108-
on YouTube. [Please follow this guideline for more details][].
108+
on YouTube. [Please follow this guideline for more details].
109109

110110
If a violation has been addressed by a host and it has been recorded by Zoom,
111-
the video should be edited before being posted on the [Kubernetes channel][].
111+
the video should be edited before being posted on the [Kubernetes channel].
112112

113-
Contact [SIG Contributor Experience][] if you need help to edit a video
113+
Contact [SIG Contributor Experience] if you need help to edit a video
114114
before posting it to the public.
115115

116116
## Screen sharing guidelines and recommendations
117117

118-
Zoom has [documentation on how to use their screen sharing feature][].
118+
Zoom has [documentation on how to use their screen sharing feature].
119119

120120
Recommendations:
121121

@@ -129,7 +129,7 @@ Recommendations:
129129
## Audio/Video quality recommendations
130130

131131
While video conferencing has been a real boon to productivity there are still
132-
[lots of things that can go wrong][] during a conference video call.
132+
[lots of things that can go wrong] during a conference video call.
133133

134134
There are some things that are just plain out of your control, but there are
135135
some things that you can control. Here are some tips if you're just getting into
@@ -142,8 +142,8 @@ favor.
142142
- **A dedicated microphone** - This is the number one upgrade you can do.
143143
Sound is one of those things that can immediately change the quality of
144144
your call. If you plan on being here for the long haul, something like a
145-
[Blue Yeti][] will work great due to the simplicity of using USB
146-
audio and having a hardware mute button. Consider a [pop filter][]
145+
[Blue Yeti] will work great due to the simplicity of using USB
146+
audio and having a hardware mute button. Consider a [pop filter]
147147
as well if necessary.
148148
- **A Video Camera** - A bad image can be worked around if the audio is good.
149149
Certain models have noise canceling dual-microphones, which are a great
@@ -165,7 +165,7 @@ for which models work best.
165165

166166
### Pro-tips
167167

168-
- [Join on muted audio and video][] in order to prevent noise to those
168+
- [Join on muted audio and video] in order to prevent noise to those
169169
already in a call.
170170
- If you don't have anything to say at that moment, **MUTE**. This is a common
171171
problem. You can help out a teammate by mentioning it on Zoom chat or

contributors/guide/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Here are some pull requests with examples of exemplary release notes:
7373
- https://github.com/kubernetes/kubernetes/pull/97252
7474
- https://github.com/kubernetes/kubernetes/pull/105517
7575

76-
For more tips on writing good release notes, check out the [Release Notes Handbook][].
76+
For more tips on writing good release notes, check out the [Release Notes Handbook].
7777

7878
## Applying a Release Note
7979

0 commit comments

Comments
 (0)