Contributor guide folder and central starting point README outline #1409
Conversation
|
/sig contribex |
|
/ok-to-test Will review this :) |
|
Looks good as the foundation, please fix the minor issues after my comments. |
|
|
||
| Kubernetes is the main focus of CloudNativeCon/KubeCon, held every spring in Europe and winter in North America. Information about these and other community events is available on the CNCF [events](https://www.cncf.io/events/) pages. | ||
|
|
||
| ### Meetups |
idvoretskyi
Nov 16, 2017
Member
Please, leave as is, I'll update after merging.
Please, leave as is, I'll update after merging.
| * include link to meetups | ||
| * information on CNCF support for founding a Meetup | ||
|
|
||
| ### Kubecon |
idvoretskyi
Nov 16, 2017
Member
KubeCon
KubeCon
|
|
||
| ## Events | ||
|
|
||
| Kubernetes is the main focus of CloudNativeCon/KubeCon, held every spring in Europe and winter in North America. Information about these and other community events is available on the CNCF [events](https://www.cncf.io/events/) pages. |
idvoretskyi
Nov 16, 2017
Member
Kubernetes is the main focus of CloudNativeCon/KubeCon, held twice per year in EMEA and in North America. Information about these and other community events is available on the CNCF events pages.
Kubernetes is the main focus of CloudNativeCon/KubeCon, held twice per year in EMEA and in North America. Information about these and other community events is available on the CNCF events pages.
idvoretskyi
Nov 16, 2017
Member
Edited. We don't necessarily run KubeCon only in winter and spring. Also, not necessarily Europe (but EMEA).
Edited. We don't necessarily run KubeCon only in winter and spring. Also, not necessarily Europe (but EMEA).
| @@ -0,0 +1,212 @@ | |||
| **OWNER:** | |||
|
|
|||
| SIG-ContribX | |||
cblecker
Nov 16, 2017
Member
nit: sig-contributor-experience
nit: sig-contributor-experience
| SIG-ContribX | ||
|
|
||
|
|
||
| # WARNING |
cblecker
Nov 16, 2017
Member
Starting a new contributor document with an H1 WARNING isn't super friendly. Perhaps say this is a disclaimer?
Starting a new contributor document with an H1 WARNING isn't super friendly. Perhaps say this is a disclaimer?
idvoretskyi
Nov 17, 2017
Member
+1
+1
|
|
||
| Many of the links below should lead to relevant documents scattered across the community repository. Often, the linked instructions need to be updated or cleaned up. | ||
|
|
||
| * If you do so, please port the relevant file from its previous location to come live in the community/contributors/guide folder, and delete its previous location. |
cblecker
Nov 16, 2017
Member
suggestion: s/port/{move|relocate}/ -- easier to understand, especially with newer english speakers
suggestion: s/port/{move|relocate}/ -- easier to understand, especially with newer english speakers
| Many of the links below should lead to relevant documents scattered across the community repository. Often, the linked instructions need to be updated or cleaned up. | ||
|
|
||
| * If you do so, please port the relevant file from its previous location to come live in the community/contributors/guide folder, and delete its previous location. | ||
| * Ultimately, all contributor guide specific files will live in this folder. |
cblecker
Nov 16, 2017
Member
suggestion: s/Ultimately/Our goal is/ -- more open tone as it conveys that we're a big team and inviting people to become a part of it
suggestion: s/Ultimately/Our goal is/ -- more open tone as it conveys that we're a big team and inviting people to become a part of it
|
|
||
| ## Sign the CLA | ||
|
|
||
| Before you can contribute, you will need to sign the [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md). |
cblecker
Nov 16, 2017
Member
Relative links work, and help when you're working in a fork or branch. So something like /CLA.md in this markdown file should link to the right place. You can do a find/replace for anything https://github.com/kubernetes/community/blob/master/ or https://github.com/kubernetes/community/tree/master/ and subsitute it with /.
Relative links work, and help when you're working in a fork or branch. So something like /CLA.md in this markdown file should link to the right place. You can do a find/replace for anything https://github.com/kubernetes/community/blob/master/ or https://github.com/kubernetes/community/tree/master/ and subsitute it with /.
idvoretskyi
Nov 17, 2017
Member
I'd keep the full path if this document will be moved somewhere.
I'd keep the full path if this document will be moved somewhere.
cblecker
Nov 17, 2017
Member
Oh, if the goal is to move this out of community, then I agree.
In that case, I’d suggest https://git.k8s.io/community/CLA.md (and similar). That’s a redirect we own and provides for a clean, consistent anchor for fully qualified URLs
Oh, if the goal is to move this out of community, then I agree.
In that case, I’d suggest https://git.k8s.io/community/CLA.md (and similar). That’s a redirect we own and provides for a clean, consistent anchor for fully qualified URLs
guineveresaenger
Nov 17, 2017
Author
Contributor
Huh. I was unaware of those. Do all kubernetes github files have such a redirect?
And yes, relative files +1, but after we move them into the /guide folder, which in the case of CLA we should.
Huh. I was unaware of those. Do all kubernetes github files have such a redirect?
And yes, relative files +1, but after we move them into the /guide folder, which in the case of CLA we should.
cblecker
Nov 17, 2017
Member
git.k8s.io is just an nginx redirector.. code is here: https://github.com/kubernetes/k8s.io/blob/8320db3841550deb6084137e0533fdc8c193d9b7/k8s.io/configmap-nginx.yaml#L183-L193
and yes, it works for any github.com/kubernetes/ repo
git.k8s.io is just an nginx redirector.. code is here: https://github.com/kubernetes/k8s.io/blob/8320db3841550deb6084137e0533fdc8c193d9b7/k8s.io/configmap-nginx.yaml#L183-L193
and yes, it works for any github.com/kubernetes/ repo
|
|
||
| ### Meetups | ||
|
|
||
| __Improvements needed_ |
cblecker
Nov 16, 2017
Member
I think the two underscores here mess up the formatting a bit.
I think the two underscores here mess up the formatting a bit.
|
|
||
| _Improvements needed_ | ||
| * edit above link to only provide code review section. | ||
| * decide whether this is something that belongs in this section, or should be combined with Contributing instructions [below](https://github.com/guineveresaenger/community/tree/contributor-guide/contributors/guide#contributing). |
cblecker
Nov 16, 2017
Member
Links to a personal repo, per above, this should be a relative link (e.g. /contributor-guide/contributors/guide#contributing)
Links to a personal repo, per above, this should be a relative link (e.g. /contributor-guide/contributors/guide#contributing)
guineveresaenger
Nov 17, 2017
Author
Contributor
whoops
whoops
|
|
||
| * Possible text to elaborate on (the sig list should remain in its current place however): | ||
|
|
||
| * ([Pick a SIG](https://github.com/kubernetes/community/blob/master/sig-list.md), peruse its associated [cmd](https://github.com/kubernetes/kubernetes/tree/master/cmd) directory, find a main() and read code until you find something you want to fix.) |
cblecker
Nov 16, 2017
Member
git.k8s.io/kubernetes/master/cmd
git.k8s.io/kubernetes/master/cmd
|
Thank you @cblecker I will update tomorrow PST :) |
|
Apologies @cblecker - got a bit swamped on Friday afternoon. All changes should be addressed now. |
|
/lgtm |
|
/test all [submit-queue is verifying that this PR is safe to merge] |
|
Automatic merge from submit-queue. |
|
@stp-ip @guineveresaenger In future, we should be squashing before merge (to keep the tree at least somewhat clean) |
|
@cblecker Yes missed that. Was checking the whole content and if all comments were addressed. Sorry my fault. |
|
@cblecker in kubernetes do we "squash and merge" or do we squash before submitting PR/force-push with altered history in case of changes? |
|
(I had assumed the former) |
|
The latter. The actual merge is handled by a bot, and just does a straight git merge |
|
Having split up commits helps from a review standpoint, but then once all comments are addressed, usually the last step is the author squashing into a readable git history |
|
Makes sense. Thank you for your patience. makes mental note to go through that part of this very documentation with a fine comb |
This is the starting point for creating a single source of truth for how to contribute to Kubernetes.
A follow-up umbrella issue will be filed that contains a list of tasks that need to be completed to fully migrate all the information to a central source of truth.
The README itself contains references to tasks that are still outstanding, but it would be helpful to have it merged into master, so we have somewhere to point people, to make them aware this is being worked on, and perhaps to garner more help.