kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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]: <link>`).

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 <stmcg@amazon.com>
This commit is contained in:
Sean McGinnis 2023-01-11 14:30:04 +01:00
parent dfb18ba179
commit f2f923ea26
No known key found for this signature in database
GPG Key ID: 33B8D6A975CFF6FE
5 changed files with 108 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
communication/slack-guidelines.md
View File

@ -396,7 +396,7 @@ Report any actions taken to the other slack admins, and if needed the
[Channel Documentation]: ./slack-config/README.md [Channel Documentation]: ./slack-config/README.md
[sig-list]: https://www.kubernetes.dev/community/community-groups [sig-list]: https://www.kubernetes.dev/community/community-groups
[Slack Config Documentation]: ./slack-config/README.md [Slack Config Documentation]: ./slack-config/README.md
[OWNERS]: /contributors/guide/owners [OWNERS]: /contributors/guide/OWNERS
[usergroups.yaml]: ./slack-config/usergroups.yaml [usergroups.yaml]: ./slack-config/usergroups.yaml
[User Group Documentation]: ./slack-config/README.md#usergroups [User Group Documentation]: ./slack-config/README.md#usergroups
[GitHub Issue]: https://github.com/kubernetes/community/issues/new/choose [GitHub Issue]: https://github.com/kubernetes/community/issues/new/choose

8
events/2016/developer-summit-2016/KubDevSummitVoting.md
View File

@ -1,11 +1,11 @@
### Kubernetes Developer's Summit Discussion Topics Voting ### Kubernetes Developer's Summit Discussion Topics Voting
###
A voting poll for discussion topic proposals has been created, and the link to the poll can be found [here][poll]. A voting poll for discussion topic proposals has been created, and the link to the poll can be found [here][poll].
The poll will close on 10/07/16 at 23:59:59 PDT. The poll will close on 10/07/16 at 23:59:59 PDT.
#### How Does it Work? #### How Does it Work?
####
The voting uses the Condorcet method, which relies on relative rankings to pick winners. You can read more about the Condorcet method and the voting service we're using on the [CIVS website][civs]. The voting uses the Condorcet method, which relies on relative rankings to pick winners. You can read more about the Condorcet method and the voting service we're using on the [CIVS website][civs].
There are 27 topics to choose from, and you will rank them from 1 (favorite) to 27 (least favorite). You can also mark "no opinion" on topics that you don't wish to include in the ranking. There are 27 topics to choose from, and you will rank them from 1 (favorite) to 27 (least favorite). You can also mark "no opinion" on topics that you don't wish to include in the ranking.
@ -15,19 +15,17 @@ The poll on CIVS has just the topic titles for ease of viewing. For topic descri
You will note the message saying "*Only the 15 favorite choices will win the poll*". CIVS requires a number be selected for winners, and we have arbitrarily chosen 15. The final schedule may include more or less than 15 of the submitted topics. You will note the message saying "*Only the 15 favorite choices will win the poll*". CIVS requires a number be selected for winners, and we have arbitrarily chosen 15. The final schedule may include more or less than 15 of the submitted topics.
##### A Small Request ##### A Small Request
#####
In order to make the poll accessible via URL, it has to be made "public". This means than any unique IP address can vote, which can be easily exploited for multiple votes. In order to make the poll accessible via URL, it has to be made "public". This means than any unique IP address can vote, which can be easily exploited for multiple votes.
We fully expect the community to behave with sportsmanship and only vote once, and as such we almost didn't bring this concern up to begin with. However, we have chosen to explicitly address it, in order to reiterate the importance of everyone's voice receiving equal weight in a community-driven event. We fully expect the community to behave with sportsmanship and only vote once, and as such we almost didn't bring this concern up to begin with. However, we have chosen to explicitly address it, in order to reiterate the importance of everyone's voice receiving equal weight in a community-driven event.
#### After the Poll #### After the Poll
####
A schedule will be made from the winning topics with A schedule will be made from the winning topics with
some editorial license, and the schedule will be announced to the group some editorial license, and the schedule will be announced to the group
at least a week before the event. at least a week before the event.
[//]: # (Reference Links)
[civs]: <http://civs.cs.cornell.edu/> [civs]: <http://civs.cs.cornell.edu/>
[poll]: <http://civs.cs.cornell.edu/cgi-bin/vote.pl?id=E_9ef4ac5e58c4cab1&akey=7cc2652f9715b525> [poll]: <http://civs.cs.cornell.edu/cgi-bin/vote.pl?id=E_9ef4ac5e58c4cab1&akey=7cc2652f9715b525>
[topics]: <https://docs.google.com/spreadsheets/d/1bmp6uLG8H32MVz02-zsieeKKZDZITw-8B6UjOaNTXOA/edit?usp=sharing> [topics]: <https://docs.google.com/spreadsheets/d/1bmp6uLG8H32MVz02-zsieeKKZDZITw-8B6UjOaNTXOA/edit?usp=sharing>

16
events/2016/developer-summit-2016/Kubernetes_Dev_Summit.md
View File

@ -1,12 +1,11 @@
# Kubernetes Dev Summit # Kubernetes Dev Summit
#
## Edit - Event Location ## Edit - Event Location
##
The event is on the 4th Floor of the *Union Street Tower* of the Sheraton Seattle Hotel. The event is on the 4th Floor of the *Union Street Tower* of the Sheraton Seattle Hotel.
# About the Event # About the Event
#
The Kubernetes Developers' Summit provides an avenue for Kubernetes The Kubernetes Developers' Summit provides an avenue for Kubernetes
developers to connect face to face and mindshare about future community developers to connect face to face and mindshare about future community
development and community governance endeavors. development and community governance endeavors.
@ -15,7 +14,7 @@ In some sense, the summit is a real-life extension of the community
meetings and SIG meetings. meetings and SIG meetings.
## Event Format ## Event Format
##
The Dev Summit is a "loosely-structured [unconference][uncf]". Rather The Dev Summit is a "loosely-structured [unconference][uncf]". Rather
than speakers and presentations, we will have moderators/facilitators than speakers and presentations, we will have moderators/facilitators
and discussion topics, alongside all-day completely unstructured and discussion topics, alongside all-day completely unstructured
@ -35,7 +34,7 @@ Then, there will be 2 smaller rooms for hacking / unstructured
discussion all day. discussion all day.
#### Who Should Go? #### Who Should Go?
####
The target audience is the Kubernetes developer community. The group The target audience is the Kubernetes developer community. The group
will be relatively small (~120-150 attendees), to improve communication will be relatively small (~120-150 attendees), to improve communication
and facilitate easier decision-making. The majority of the attendees and facilitate easier decision-making. The majority of the attendees
@ -52,7 +51,7 @@ Please note that this Summit is not the right environment for people to
involved initially. involved initially.
#### Call for Proposals #### Call for Proposals
####
Proposals for discussion topics can be submitted through [this Proposals for discussion topics can be submitted through [this
form][propfrm] by September 30, 23:59 PT. If you propose a session topic, form][propfrm] by September 30, 23:59 PT. If you propose a session topic,
please be prepared to attend and facilitate the session if it gets please be prepared to attend and facilitate the session if it gets
@ -71,7 +70,7 @@ some editorial license, and the schedule will be announced to the group
at least a week before the event. at least a week before the event.
## When & Where? ## When & Where?
##
The Dev Summit will follow [Kubecon][kbc] on November 10th, 2016. The Dev Summit will follow [Kubecon][kbc] on November 10th, 2016.
Fortunately for those who attend Kubecon, the Dev Summit will be at the Fortunately for those who attend Kubecon, the Dev Summit will be at the
same venue, [the Sheraton Seattle Hotel][sher]. As of now, the day's same venue, [the Sheraton Seattle Hotel][sher]. As of now, the day's
@ -79,14 +78,13 @@ activities should run from breakfast being served at 8 AM to closing
remarks ending around 3:30 PM, with an external happy hour to follow. remarks ending around 3:30 PM, with an external happy hour to follow.
## Desired outcomes ## Desired outcomes
##
* Generate notes from the sessions to feed the project's documentation * Generate notes from the sessions to feed the project's documentation
and knowledge base, and also to keep non-attendees plugged in and knowledge base, and also to keep non-attendees plugged in
* Make (and document) recommendations and decisions for the near-term and * Make (and document) recommendations and decisions for the near-term and
mid-term future of the project mid-term future of the project
* Come up with upcoming action items, as well as leaders for those action items, for the various topics that we discuss * Come up with upcoming action items, as well as leaders for those action items, for the various topics that we discuss
[//]: # (Reference Links)
[uncf]: <https://en.wikipedia.org/wiki/Unconference> [uncf]: <https://en.wikipedia.org/wiki/Unconference>
[mtp]: <http://www.meetup.com/topics/kubernetes/all/> [mtp]: <http://www.meetup.com/topics/kubernetes/all/>
[lotfrm]: <https://docs.google.com/forms/d/e/1FAIpQLSe8t6pvRjh1OeF6xrXKbXmzHGMhQ4c-MbZ6QUr9APJNjpgAzA/viewform> [lotfrm]: <https://docs.google.com/forms/d/e/1FAIpQLSe8t6pvRjh1OeF6xrXKbXmzHGMhQ4c-MbZ6QUr9APJNjpgAzA/viewform>