Organize Design Proposals Dir by SIG #1010

grodrigues3 · 2017-08-31T23:17:57Z

Organize design proposals directory into sigs. This will make it easier to assign reviewers for future proposals.

Fixes #918

liggitt · 2017-08-31T23:21:11Z

What's the plan for proposals involving multiple sigs?

grodrigues3 · 2017-08-31T23:25:27Z

I'm open to suggestions. a multi-sig directory or something equivalent? maybe just the base dir?

bgrant0607 · 2017-09-01T03:46:21Z

@liggitt I haven't reviewed this yet, but my thinking is as follows:

There should usually be a primary SIG owner, but that doesn't preclude notifying other SIGs and adding approvers from other SIGs
There are many SIGs with project-wide impact, which would normally be the primary owners
Proposals/designs/conventions that truly span the whole project likely would go into sig-architecture
There are some things in design-proposals that probably don't belong there

See discussion in #967 and https://groups.google.com/forum/#!topic/kubernetes-sig-architecture/t-1EqeEoLPA

cc @kubernetes/sig-architecture-pr-reviews @smarterclayton

bgrant0607 · 2017-09-01T03:51:14Z

@grodrigues3 Were there any you weren't sure about?

Why are some files deleted and added rather than just moved?

This isn't as easy to read as a doc or spreadsheet. The github UI abbreviates the paths.

bgrant0607 · 2017-09-01T03:52:58Z

@grodrigues3 A number of these will need to be changed. Could we please start with a doc, spreadsheet, or something easier to read and edit or comment on?

smarterclayton · 2017-09-01T03:56:03Z

Also note that you deleted some proposals :)

grodrigues3 · 2017-09-01T16:45:50Z

Yeah, I'll start with a sheet.

If I deleted any, it was a mistake.

EDIT: just looked at my tree and I moved some without committing (which I think git interpreted as a deleted). I'll refactor this as a sheet or something more parsable.

I created folders for sigs, and just dragged proposals over.

grodrigues3 · 2017-09-01T18:11:59Z

How's this, can you comment on that and I change move and update things accordingly?

msau42 · 2017-09-01T23:45:47Z

contributors/design-proposals/dir_struct.txt

+	identifiers.md
+	local-cluster-ux.md
+	pod-pid-namespace.md
+	grow-volume-size.md


sig storage

mbohlool · 2017-10-11T02:08:20Z

I am not sure if I understand your distinction between contributor and developer. In this specific case that we defined client's capability and have a badge for it in README files, What do you suggest?

…

On Oct 10, 2017 6:52 PM, "Brian Grant" ***@***.***> wrote: @mbohlool <https://github.com/mbohlool> Kubernetes developer-oriented docs should not be pointed at contributor docs. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1010 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABic4JDjwwve9x_ODyqvEue1sdT3di_oks5srB95gaJpZM4PJhjF> .

bgrant0607 · 2017-10-11T02:53:54Z

@mbohlool

An example:

Contributors == people sending us PRs (in this context)

This looks like a document intended to be read by developers using the client library to build on top of K8s APIs for their own purposes:
https://github.com/kubernetes-client/python-base/blob/master/README.md

That puts them in a "user" category.

Therefore the docs should be written for users and belong on kubernetes.io or in the client repos themselves.

@bgrant0607

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in kubeadm after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in kubeadm after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ```

@bgrant0607

Automatic merge from submit-queue (batch tested with PRs 52556, 52897, 54342). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in api after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in api after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ```

@bgrant0607

Automatic merge from submit-queue (batch tested with PRs 52556, 52897, 54342). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in api after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in api after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ``` Kubernetes-commit: e02d4a985554ceeff1f4456693f71b419df599f6

@bgrant0607

Automatic merge from submit-queue (batch tested with PRs 52556, 52897, 54342). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in api after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in api after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ``` Kubernetes-commit: e02d4a985554ceeff1f4456693f71b419df599f6

@bgrant0607

Automatic merge from submit-queue (batch tested with PRs 52556, 52897, 54342). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in api after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in api after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ``` Kubernetes-commit: e02d4a985554ceeff1f4456693f71b419df599f6

@bgrant0607

Automatic merge from submit-queue (batch tested with PRs 52556, 52897, 54342). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in api after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in api after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ``` Kubernetes-commit: e02d4a985554ceeff1f4456693f71b419df599f6

This is mostly replacing https://github.com/kubernetes/community/blob/master/... links with relative links, because relative links are easier to maintain. For example, if you rename a.md to b.md in a feature branch, updating an ../a.md to ../b.md target will work immediately (e.g. during pull-request review), while updating https://github.com/kubernetes/community/blob/master/a.md to https://github.com/kubernetes/community/blob/master/b.md will only work after your branch lands the rename in master. I'm not sure why the #L1454 fragment was part of the old sig-governance template sigs.yaml link, but it's been there since the template landed in 68658bf (Provide short template for SIG governance, 2018-02-23, kubernetes#1830). I've removed it in this commit. The Kubernetes Charter README link in the sig-governance template could just be: [Kubernetes Charter README]: README.md but I've sent it down to the project root and back to make life easier on new SIGs which copy/paste the file to a new location in this repository. With this commit they'll just need to drop one level of ../ to get the references working from places like sig-contributor-experience/charter.md. I've also chased a few files and anchors as they've moved around (e.g. the OBSOLETE_templates.md rename from 18958f8 (addressing Brians comments, 2017-09-06, kubernetes#1010) and the "and maintenance" header addition from f471f6b (Add new contact info for Paris and me, 2017-10-17, kubernetes#1215). This commit isn't complete, but it's a step in the right direction and all I had time for tonight ;).

This is mostly replacing https://github.com/kubernetes/community/blob/master/... links with relative links, because relative links are easier to maintain. For example, if you rename a.md to b.md in a feature branch, updating an ../a.md to ../b.md target will work immediately (e.g. during pull-request review), while updating https://github.com/kubernetes/community/blob/master/a.md to https://github.com/kubernetes/community/blob/master/b.md will only work after your branch lands the rename in master. I'm not sure why the #L1454 fragment was part of the old sig-governance template sigs.yaml link, but it's been there since the template landed in 68658bf (Provide short template for SIG governance, 2018-02-23, kubernetes#1830). I've removed it in this commit. The Kubernetes Charter README link in the sig-governance template could just be: [Kubernetes Charter README]: README.md but I've sent it down to the project root and back to make life easier on new SIGs which copy/paste the file to a new location in this repository. With this commit they'll just need to drop one level of ../ to get the references working from places like sig-contributor-experience/charter.md. I've also chased a few files and anchors as they've moved around, e.g. the OBSOLETE_templates.md rename from 18958f8 (addressing Brians comments, 2017-09-06, kubernetes#1010) and the "and maintenance" header addition from f471f6b (Add new contact info for Paris and me, 2017-10-17, This commit isn't complete, but it's a step in the right direction and all I had time for tonight ;).

This is mostly replacing https://github.com/kubernetes/community/blob/master/... links with relative links, because relative links are easier to maintain. For example, if you rename a.md to b.md in a feature branch, updating an /a.md to /b.md target will work immediately (e.g. during pull-request review), while updating https://github.com/kubernetes/community/blob/master/a.md to https://github.com/kubernetes/community/blob/master/b.md will only work after your branch lands the rename in master. I'm not sure why the #L1454 fragment was part of the old sig-governance template sigs.yaml link, but it's been there since the template landed in 68658bf (Provide short template for SIG governance, 2018-02-23, kubernetes#1830). I've removed it in this commit. The Kubernetes Charter README link in the sig-governance template could just be: [Kubernetes Charter README]: README.md but I've based it on the project root and back to make life easier on new SIGs which copy/paste the file to a new location in this repository. I personally prefer targets that use ../ for referencing other directories within a project, because those also work with generic Markdown tools (e.g. Emacs' Markdown mode). I've gone with /-rooted targets in this commit as requested in /sig-contributor-experience/markdown-link-style-guide.md. I've also chased a few files and anchors as they've moved around, e.g. the OBSOLETE_templates.md rename from 18958f8 (addressing Brians comments, 2017-09-06, kubernetes#1010) and the "and maintenance" header addition from f471f6b (Add new contact info for Paris and me, 2017-10-17, This commit isn't complete, but it's a step in the right direction and all I had time for tonight ;).

This is mostly replacing https://github.com/kubernetes/community/blob/master/... links with relative links, because relative links are easier to maintain. For example, if you rename a.md to b.md in a feature branch, updating an /a.md to /b.md target will work immediately (e.g. during pull-request review), while updating https://github.com/kubernetes/community/blob/master/a.md to https://github.com/kubernetes/community/blob/master/b.md will only work after your branch lands the rename in master. I'm not sure why the #L1454 fragment was part of the old sig-governance template sigs.yaml link, but it's been there since the template landed in 68658bf (Provide short template for SIG governance, 2018-02-23, kubernetes#1830). I've removed it in this commit. The Kubernetes Charter README link in the sig-governance template could just be: [Kubernetes Charter README]: README.md but I've based it on the project root and back to make life easier on new SIGs which copy/paste the file to a new location in this repository. I personally prefer targets that use ../ for referencing other directories within a project, because those also work with generic Markdown tools (e.g. Emacs' Markdown mode). I've gone with /-rooted targets in this commit as requested in /sig-contributor-experience/markdown-link-style-guide.md. I've also chased a few files and anchors as they've moved around, e.g. the OBSOLETE_templates.md rename from 18958f8 (addressing Brians comments, 2017-09-06, kubernetes#1010) and the "and maintenance" header addition from f471f6b (Add new contact info for Paris and me, 2017-10-17, This commit isn't complete, but it's a step in the right direction and all I had time for tonight ;). The sig-list.md changes were generated automatically from the generator/list.tmpl changes with: $ make generate

@grodrigues3

Automatic merge from submit-queue. Fix links after design proposals move Some links broke when design proposals were organized in kubernetes/community#1010. They were mostly fixed in kubernetes/community#1116 but a few seem to still be pointing to the old ones. Takes another stab at kubernetes/community#1109. /cc @grodrigues3

@grodrigues3

Automatic merge from submit-queue. . flex-volumes-drivers-psp.md: move from storage/ to auth/ Follow-up to kubernetes#1010 CC @grodrigues3 @simo5

@grodrigues3

Automatic merge from submit-queue. . Move runas-groupid proposal to auth subdir Follow-up to kubernetes#1010 CC @grodrigues3 @simo5

@grodrigues3

Automatic merge from submit-queue. Fix links after design proposals move Some links broke when design proposals were organized in kubernetes/community#1010. They were mostly fixed in kubernetes/community#1116 but a few seem to still be pointing to the old ones. Takes another stab at kubernetes/community#1109. /cc @grodrigues3

@grodrigues3

Automatic merge from submit-queue. Fix links after design proposals move Some links broke when design proposals were organized in kubernetes/community#1010. They were mostly fixed in kubernetes/community#1116 but a few seem to still be pointing to the old ones. Takes another stab at kubernetes/community#1109. /cc @grodrigues3

@grodrigues3

Automatic merge from submit-queue. Fix links after design proposals move Some links broke when design proposals were organized in kubernetes/community#1010. They were mostly fixed in kubernetes/community#1116 but a few seem to still be pointing to the old ones. Takes another stab at kubernetes/community#1109. /cc @grodrigues3

@grodrigues3

Automatic merge from submit-queue. Fix links after design proposals move Some links broke when design proposals were organized in kubernetes/community#1010. They were mostly fixed in kubernetes/community#1116 but a few seem to still be pointing to the old ones. Takes another stab at kubernetes/community#1109. /cc @grodrigues3

@grodrigues3

Automatic merge from submit-queue. Fix links after design proposals move Some links broke when design proposals were organized in kubernetes/community#1010. They were mostly fixed in kubernetes/community#1116 but a few seem to still be pointing to the old ones. Takes another stab at kubernetes/community#1109. /cc @grodrigues3

@grodrigues3

Automatic merge from submit-queue. Fix links after design proposals move Some links broke when design proposals were organized in kubernetes/community#1010. They were mostly fixed in kubernetes/community#1116 but a few seem to still be pointing to the old ones. Takes another stab at kubernetes/community#1109. /cc @grodrigues3

@bgrant0607

Automatic merge from submit-queue (batch tested with PRs 52556, 52897, 54342). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in api after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in api after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ``` Kubernetes-commit: e02d4a985554ceeff1f4456693f71b419df599f6

…rnetes#1010)

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 31, 2017

k8s-github-robot assigned bgrant0607 and wojtek-t Aug 31, 2017

k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 31, 2017

grodrigues3 force-pushed the org-design-propals branch from f0b97e8 to db4631a Compare August 31, 2017 23:19

k8s-github-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 31, 2017

grodrigues3 force-pushed the org-design-propals branch from db4631a to 7717af0 Compare August 31, 2017 23:24

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 31, 2017

k8s-ci-robot added the sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. label Sep 1, 2017

bgrant0607 assigned smarterclayton and unassigned wojtek-t Sep 1, 2017

smarterclayton added the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Sep 1, 2017

grodrigues3 force-pushed the org-design-propals branch from 657b76e to ea28b89 Compare September 1, 2017 18:12

cblecker mentioned this pull request Sep 1, 2017

Add OWNERS for sig-storage design proposals #1013

Merged

msau42 reviewed Sep 1, 2017

View reviewed changes

k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 1, 2017

cblecker mentioned this pull request Oct 27, 2017

Add sig labels and use aliases in OWNERS files #1283

Merged

huzhengchuan mentioned this pull request Dec 27, 2017

kubctl explain resourcequota.spec.hard incomplete kubernetes/kubectl#190

Closed

wking mentioned this pull request May 22, 2018

*: Assorted internal-reference cleanups #2174

Closed

danehans pushed a commit to danehans/community that referenced this pull request Jul 18, 2023

Automator: update common-files@master in istio/community@master (kube…

21699cf

…rnetes#1010)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Organize Design Proposals Dir by SIG #1010

Organize Design Proposals Dir by SIG #1010

grodrigues3 commented Aug 31, 2017 •

edited by bgrant0607

Loading

liggitt commented Aug 31, 2017

grodrigues3 commented Aug 31, 2017

bgrant0607 commented Sep 1, 2017

bgrant0607 commented Sep 1, 2017

bgrant0607 commented Sep 1, 2017

smarterclayton commented Sep 1, 2017

grodrigues3 commented Sep 1, 2017 •

edited

Loading

grodrigues3 commented Sep 1, 2017 •

edited

Loading

msau42 Sep 1, 2017

mbohlool commented Oct 11, 2017 via email

bgrant0607 commented Oct 11, 2017

Organize Design Proposals Dir by SIG #1010

Organize Design Proposals Dir by SIG #1010

Conversation

grodrigues3 commented Aug 31, 2017 • edited by bgrant0607 Loading

liggitt commented Aug 31, 2017

grodrigues3 commented Aug 31, 2017

bgrant0607 commented Sep 1, 2017

bgrant0607 commented Sep 1, 2017

bgrant0607 commented Sep 1, 2017

smarterclayton commented Sep 1, 2017

grodrigues3 commented Sep 1, 2017 • edited Loading

grodrigues3 commented Sep 1, 2017 • edited Loading

msau42 Sep 1, 2017

Choose a reason for hiding this comment

mbohlool commented Oct 11, 2017 via email

bgrant0607 commented Oct 11, 2017

grodrigues3 commented Aug 31, 2017 •

edited by bgrant0607

Loading

grodrigues3 commented Sep 1, 2017 •

edited

Loading

grodrigues3 commented Sep 1, 2017 •

edited

Loading