From f2f923ea26bd08cafc180331b5fbbf26bfa28ed0 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Wed, 11 Jan 2023 14:30:04 +0100 Subject: Correct reference link formatting When using reference links (`[a link to something][something]`) the link goes itself is referred to later in the file. This normally should be a line that starts with the reference name in brackets, followed by the actual link (`[something]: `). Many of these reference links in the repo have unnecessary leading spaces. While this renders OK, at least with GitHub's markdown rendering, it currently causes problems for sites like kubernetes.dev that pull in these docs and attempt to update the links so they are usable from a different rendered location. While the script that does that import should probably be updated to be a little more robust, this addresses the immediate need of fixing these broken kubernetes.dev links by removing the leading whitespaces so they are properly recongized and updated. Also some very minor cleanup in some older files. While these don't appear to be imported elsewhere, they were cleaned up to avoid the risk of any future copy/paste issues that could happen prior to the doc import script being updated to handle things correctly. Signed-off-by: Sean McGinnis --- communication/slack-guidelines.md | 32 +++++++++---------- communication/youtube/youtube-guidelines.md | 46 +++++++++++++-------------- communication/zoom-guidelines.md | 48 ++++++++++++++--------------- 3 files changed, 63 insertions(+), 63 deletions(-) (limited to 'communication') diff --git a/communication/slack-guidelines.md b/communication/slack-guidelines.md index 45f0e75f..b9033940 100644 --- a/communication/slack-guidelines.md +++ b/communication/slack-guidelines.md @@ -386,19 +386,19 @@ past "X" minutes/hours. Report any actions taken to the other slack admins, and if needed the [Code of Conduct Committee][cocc]. - [coc]: /code-of-conduct.md - [admins]: ./moderators.md#Slack - [Slack Archive Download]: https://drive.google.com/drive/folders/1Xnkwsxis3tu0pT7rwp-crRq4IciZ5b1o?usp=sharing - [cocc]: /committee-code-of-conduct/README.md - [CNCF Slack]: https://slack.cncf.io/ - [Tempelis]: http://sigs.k8s.io/slack-infra/tempelis - [slack-config]: ./slack-config/ - [Channel Documentation]: ./slack-config/README.md - [sig-list]: https://www.kubernetes.dev/community/community-groups - [Slack Config Documentation]: ./slack-config/README.md - [OWNERS]: /contributors/guide/owners - [usergroups.yaml]: ./slack-config/usergroups.yaml - [User Group Documentation]: ./slack-config/README.md#usergroups - [GitHub Issue]: https://github.com/kubernetes/community/issues/new/choose - [moderation guidelines]: ./moderation.md - [Slack's policy on inactivated accounts]: https://get.slack.help/hc/en-us/articles/204475027-Deactivate-a-member-s-account +[coc]: /code-of-conduct.md +[admins]: ./moderators.md#Slack +[Slack Archive Download]: https://drive.google.com/drive/folders/1Xnkwsxis3tu0pT7rwp-crRq4IciZ5b1o?usp=sharing +[cocc]: /committee-code-of-conduct/README.md +[CNCF Slack]: https://slack.cncf.io/ +[Tempelis]: http://sigs.k8s.io/slack-infra/tempelis +[slack-config]: ./slack-config/ +[Channel Documentation]: ./slack-config/README.md +[sig-list]: https://www.kubernetes.dev/community/community-groups +[Slack Config Documentation]: ./slack-config/README.md +[OWNERS]: /contributors/guide/OWNERS +[usergroups.yaml]: ./slack-config/usergroups.yaml +[User Group Documentation]: ./slack-config/README.md#usergroups +[GitHub Issue]: https://github.com/kubernetes/community/issues/new/choose +[moderation guidelines]: ./moderation.md +[Slack's policy on inactivated accounts]: https://get.slack.help/hc/en-us/articles/204475027-Deactivate-a-member-s-account diff --git a/communication/youtube/youtube-guidelines.md b/communication/youtube/youtube-guidelines.md index 0bd56d03..a36208aa 100644 --- a/communication/youtube/youtube-guidelines.md +++ b/communication/youtube/youtube-guidelines.md @@ -236,26 +236,26 @@ downloaded and then reuploaded to the Kubernetes channel. generate thumbnails and process the videos. 7. Once videos are finalized, set the playlist to Public to publish them. - [coc]: /code-of-conduct.md - [admins]: /communication/moderators.md - [Kubernetes YouTube Channel]: https://www.youtube.com/channel/UCZ2bu0qutTOM0tHYa_jkIwg - [community meeting]: /events/community-meeting.md - [Office Hours]: /events/office-hours.md - [Meet our Contributors]: /events/meet-our-contributors.md - [Subprojects]: /governance.md#subprojects - [collaboration]: https://support.google.com/youtube/answer/6109639 - [update the permissions in your YouTube settings]: https://support.google.com/a/answer/6212415 - [YouTube admins]: /communication/moderators.md#YouTube-Channel - [SIG Contributor Experience]: /sig-contributor-experience/README.md - [moderation guidelines]: /communication/moderation.md - [trim]: https://support.google.com/youtube/answer/9057455?hl=en - [edit]: https://support.google.com/youtube/topic/9257530?hl=en&ref_topic=9257610 - [Zoom guidelines]: /communication/zoom-guidelines.md - [SIG Auth]: /sig-auth/README.md - [SIG Docs]: /sig-docs/README.md - [SIG Network]: /sig-network/README.md - [SIG Release]: /sig-release/README.md - [Steering Committee]: /committee-steering/governance/README.md - [WG Data Protection]: /wg-data-protection/README.md - [Streaming Config]: /communication/youtube/streaming-config.md - [youtube-dl]: https://ytdl-org.github.io/youtube-dl/index.html +[coc]: /code-of-conduct.md +[admins]: /communication/moderators.md +[Kubernetes YouTube Channel]: https://www.youtube.com/channel/UCZ2bu0qutTOM0tHYa_jkIwg +[community meeting]: /events/community-meeting.md +[Office Hours]: /events/office-hours.md +[Meet our Contributors]: /events/meet-our-contributors.md +[Subprojects]: /governance.md#subprojects +[collaboration]: https://support.google.com/youtube/answer/6109639 +[update the permissions in your YouTube settings]: https://support.google.com/a/answer/6212415 +[YouTube admins]: /communication/moderators.md#YouTube-Channel +[SIG Contributor Experience]: /sig-contributor-experience/README.md +[moderation guidelines]: /communication/moderation.md +[trim]: https://support.google.com/youtube/answer/9057455?hl=en +[edit]: https://support.google.com/youtube/topic/9257530?hl=en&ref_topic=9257610 +[Zoom guidelines]: /communication/zoom-guidelines.md +[SIG Auth]: /sig-auth/README.md +[SIG Docs]: /sig-docs/README.md +[SIG Network]: /sig-network/README.md +[SIG Release]: /sig-release/README.md +[Steering Committee]: /committee-steering/governance/README.md +[WG Data Protection]: /wg-data-protection/README.md +[Streaming Config]: /communication/youtube/streaming-config.md +[youtube-dl]: https://ytdl-org.github.io/youtube-dl/index.html diff --git a/communication/zoom-guidelines.md b/communication/zoom-guidelines.md index 00df1f0a..c2f531a2 100644 --- a/communication/zoom-guidelines.md +++ b/communication/zoom-guidelines.md @@ -190,27 +190,27 @@ for which models work best. Thanks for making Kubernetes meetings work great! - [community meeting]: /events/community-meeting - [SIG/WG meetings]: /sig-list.md - [Office Hours]: /events/office-hours - [Meet Our Contributors]: /mentoring/programs/meet-our-contributors.md - [Kubernetes code of conduct]: /code-of-conduct.md - [moderation]: ./moderation.md - [CNCF Service Desk]: https://github.com/cncf/servicedesk - [Zoom Admins]: ./moderators.md#zoom - [centralized list of administrators]: ./moderators.md - [sig creation procedure]: /sig-wg-lifecycle.md#communicate - [latest version]: https://zoom.us/download - [host key]: https://support.zoom.us/hc/en-us/articles/205172555-Host-Key - [waiting room]: https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room - [documentation on how to use their moderation tools]: https://support.zoom.us/hc/en-us/articles/201362603-Host-Controls-in-a-Meeting - [best practices doc]: https://docs.google.com/document/d/1fudC_diqhN2TdclGKnQ4Omu4mwom83kYbZ5uzVRI07w/edit?usp=sharing - [Code of Conduct Committee]: /committee-code-of-conduct/README.md - [Please follow this guideline for more details]: ./youtube/youtube-guidelines.md - [Kubernetes channel]: https://www.youtube.com/c/kubernetescommunity - [SIG Contributor Experience]: /sig-contributor-experience - [documentation on how to use their screen sharing feature]: https://support.zoom.us/hc/en-us/articles/201362153-How-Do-I-Share-My-Screen - [lots of things that can go wrong]: https://www.youtube.com/watch?v=JMOOG7rWTPg - [Blue Yeti]: https://www.bluedesigns.com/products/yeti/ - [pop filter]: https://en.wikipedia.org/wiki/Pop_filter - [Join on muted audio and video]: https://support.zoom.us/hc/en-us/articles/203024649-Video-Or-Microphone-Off-By-Attendee +[community meeting]: /events/community-meeting +[SIG/WG meetings]: /sig-list.md +[Office Hours]: /events/office-hours +[Meet Our Contributors]: /mentoring/programs/meet-our-contributors.md +[Kubernetes code of conduct]: /code-of-conduct.md +[moderation]: ./moderation.md +[CNCF Service Desk]: https://github.com/cncf/servicedesk +[Zoom Admins]: ./moderators.md#zoom +[centralized list of administrators]: ./moderators.md +[sig creation procedure]: /sig-wg-lifecycle.md#communicate +[latest version]: https://zoom.us/download +[host key]: https://support.zoom.us/hc/en-us/articles/205172555-Host-Key +[waiting room]: https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room +[documentation on how to use their moderation tools]: https://support.zoom.us/hc/en-us/articles/201362603-Host-Controls-in-a-Meeting +[best practices doc]: https://docs.google.com/document/d/1fudC_diqhN2TdclGKnQ4Omu4mwom83kYbZ5uzVRI07w/edit?usp=sharing +[Code of Conduct Committee]: /committee-code-of-conduct/README.md +[Please follow this guideline for more details]: ./youtube/youtube-guidelines.md +[Kubernetes channel]: https://www.youtube.com/c/kubernetescommunity +[SIG Contributor Experience]: /sig-contributor-experience +[documentation on how to use their screen sharing feature]: https://support.zoom.us/hc/en-us/articles/201362153-How-Do-I-Share-My-Screen +[lots of things that can go wrong]: https://www.youtube.com/watch?v=JMOOG7rWTPg +[Blue Yeti]: https://www.bluedesigns.com/products/yeti/ +[pop filter]: https://en.wikipedia.org/wiki/Pop_filter +[Join on muted audio and video]: https://support.zoom.us/hc/en-us/articles/203024649-Video-Or-Microphone-Off-By-Attendee -- cgit v1.2.3