Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separating proposals and architecture related items from community #2565

Closed
timothysc opened this issue Aug 21, 2018 · 42 comments
Closed

Separating proposals and architecture related items from community #2565

timothysc opened this issue Aug 21, 2018 · 42 comments
Assignees
Labels
area/enhancements Issues or PRs related to the Enhancements subproject kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/feature Categorizes issue or PR as related to a new feature. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.
Milestone

Comments

@timothysc
Copy link
Member

IMO proposals and architecture related items probably belong in their own repo now, this repo is starting to become overloaded.

/cc @jbeda @kubernetes/sig-architecture-bugs

@k8s-ci-robot k8s-ci-robot added sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. kind/bug Categorizes issue or PR as related to a bug. labels Aug 21, 2018
@thockin
Copy link
Member

thockin commented Aug 21, 2018 via email

@parispittman
Copy link
Contributor

+1

@bgrant0607
Copy link
Member

I'd want design-proposals and some docs that are currently in devel to move, as well.

Any move needs to preserve git history and leave behind forwarding links for a fair bit of time.

There's no way to move PR comments AFAIK.

@mdlinville
Copy link

You can copy and close an issue with Zenhub, which installs itself as a browser plugin and overlays some additional functionality into the Github UI. This is used in Docker and Moby repos, for instance, to move mis-filed issues to the correct repo. Of course, a PR is quite different as it actually represents a comparison between two Git objects. You probably just have to open a new PR in the new repo (which presumably has different history and file structure / locations), and link back to the original PR. It's difficult to understand how you'd automate or script this, even using Github APIs.

@justaugustus
Copy link
Member

+1 -- I think this might be a good fit for https://github.com/kubernetes-sigs/architecture-tracking, as tracking for KEPs, API reviews, and conformance testing is already happening there.

/assign @jdumars


@MistyHacks -- w.r.t. Zenhub, I've used it in the past and dig it, but it requires write access across the kubernetes org, which we're not excited about.

rel:

@justaugustus
Copy link
Member

Alternatively, we could move the KEPs to k/features and maybe rename to k/keps.
A lot of the tracking work for enhancement delivery already lives in that repo.

@nikhita
Copy link
Member

nikhita commented Aug 27, 2018

Federation was moved out from k/k to k/federation with all issue comments still intact. Example: kubernetes/kubernetes#38893 and kubernetes-retired/federation#88.

I'm not sure if some custom tool was used for this or if this was done manually (I hope not because that would be such a huge task!). @irfanurrehman can you elaborate on what you used to make sure all comments migrate so cleanly? :)

@irfanurrehman
Copy link
Contributor

@nikhita I used a hacky, custom version of https://github.com/IQAndreas/github-issues-import.
The not so nicely done hacky commits are available for reference at https://github.com/irfanurrehman/github-issues-import.

It worked as:

  1. List commits with needed labels from src repo using ./list-sig-multicluster-only-issues.py --all.
  2. Migrate issues using the actual script, for example: ./gh-issues-import.py --issues 25 26 29.

I remember facing some issues, and fixing some, and then further using some hard coded stuff specific to my job.
I recommend trying it out, one issue at a time first to see everything works fine before submitting the batch, given that its not really a maintained code.

@jdumars
Copy link
Member

jdumars commented Aug 30, 2018

Big +1 on this. It's definitely time.

@jdumars jdumars added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Aug 30, 2018
@justaugustus
Copy link
Member

Adding myself to this as well.
/sig pm
/assign

@justaugustus
Copy link
Member

@bgrant0607 -- in an attempt to level up my git-fu, I took a whack at moving keps/ and design-proposals/, while maintaining the history. PR is here: kubernetes/enhancements#613

If we're happy with moving them to k/features and renaming the repo to k/keps, then there are some additional things that would need to happen as well (not necessarily in perfect order)...

  • announce the forthcoming change
  • merge the k/features PR
  • set up blockade to prevent pushes to either dir in k/community
  • rename k/features to k/keps
  • migrate KEP / design proposal PRs to k/keps
  • create tombstones for files in both dirs in k/community
  • fix KEP / proposal links in k/keps issues
  • update docs in k/keps to clarify process
  • figure out the best way to reconcile the multiple OWNERS files between the two repos

Additionally, you wanted to move some of the files in contributors/devel out. Any ones specifically? A lot of them seem like they'd be good additions to a developer's guide, while others might fit in a dir like k/community/architecture.

Let me know what you think! :)

@timothysc
Copy link
Member Author

Can we enqueue this for the @kubernetes/sig-architecture-feature-requests call this week to discuss?

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Sep 4, 2018
@spiffxp
Copy link
Member

spiffxp commented Sep 4, 2018

Most of the docs @bgrant0607 lists above I wouldn't envision moving out of this repo. Aspirational docs, design proposals and roadmaps, yes, move to a keps/features repo.

Stated conventions developers should follow and reasons why, no, those should stay here IMO. Like @justaugustus said, those make more sense to me in a developers guide, which I would prefer to keep in close proximity to the contributor's guide.

@justaugustus you'll want to merge tombstones before you turn on blockade

We've been getting less traffic against design-proposals than we have historically, so it may be worth considering whether it's time to deprecate them, and move fully to KEPs. This seems like a good trigger for that conversation.

@justaugustus
Copy link
Member

justaugustus commented Sep 4, 2018

We've been getting less traffic against design-proposals than we have historically, so it may be worth considering whether it's time to deprecate them, and move fully to KEPs. This seems like a good trigger for that conversation.

@spiffxp -- this is exactly the effect I was hoping for.
(thanks for the tip on the tombstones!)


@timothysc -- I've put up an agenda item for the 9/6 SIG Arch meeting.

While I won't be able to attend most of the SIG Arch meetings for September, I intend to drive this with @jdumars, as it would fall under the scope of maturing the enhancement delivery process (an initiative the two of us are undertaking), which cross-cuts Arch, PgM, and PdM.

@mrbobbytables
Copy link
Member

@justaugustus -- This issue came up up at this weeks contribex meeting with regard to the contributor site (site | project). KEPs are currently displayed there along with other content from the k/community repo after being converted to a hugo friendly format. When the KEPs do relocate, the site-generation script will need to be updated to pull the additional repo and do some minor conversion. This should not be difficult, but should be coordinated with the migration.

@bgrant0607
Copy link
Member

@spiffxp On my proposed docs to move:

I agree that some contributor-focused docs on these topics need to land in the contributor doc site.

One problem right now is that most of our docs don't have a sense of who the audience is, so they mix many topics -- part design doc, part policy, part contributor instructions, part user documentation, etc. The API conventions is one example. We need user-facing docs on kubernetes.io to explain to operators and to client developers (2 audiences/personas) what common behaviors and patterns they can expect and rely on. We need a design doc (or multiple docs) to explain why things are the way they are. We need policy: MUST, SHOULD, MAY, NOT, etc. And we need a how-to guide. And a check list. And a linter. And probably other things.

If we leave these where they are for now, we should at least ensure that docs containing policy have proper OWNERS.

@justaugustus
Copy link
Member

justaugustus commented Sep 10, 2018

@bgrant0607 @jdumars -- I've created a KEP to capture the feedback provided here and across the last few SIG Architecture meetings about KEP process improvement: #2655
Open for comments!

To the devel docs discussion, I think we should drive that down as a separate effort, with Brian's suggestion of ensuring OWNERS are in place for all subdirectories being a good first step.

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 12, 2021
@mrbobbytables
Copy link
Member

/remove-lifecycle stale

I think the remaining item on this is for arch to do a review to see what items should be moved over to devel (e.g. resource-management) before we can migrate the rest to live with enhancements.

/assign @dims @johnbelamaric @derekwaynecarr

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 12, 2021
@gkarthiks gkarthiks removed their assignment Jan 23, 2021
@dims
Copy link
Member

dims commented Feb 26, 2021

@navidshaikh do you want to take this on and help with?

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 27, 2021
@nikhita
Copy link
Member

nikhita commented May 27, 2021 via email

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 27, 2021
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 25, 2021
@nikhita
Copy link
Member

nikhita commented Aug 25, 2021 via email

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 25, 2021
@mrbobbytables
Copy link
Member

As an FYI - we keep getting people opening up issues/PRs to update the design-proposals. It'd be nice to move this along and then we can finally put them some place to be permanently archived.

@MadhavJivrajani
Copy link
Contributor

@mrbobbytables fyi - #6055
created a tracking issue for this after discussing it with sig-arch in yesterday's meeting

@MadhavJivrajani
Copy link
Contributor

The relevant k/community PRs are merged:
#6259
#6258

And the repo has been updated and archived: https://github.com/kubernetes/design-proposals-archive

Closing!
/close

@k8s-ci-robot
Copy link
Contributor

@MadhavJivrajani: Closing this issue.

In response to this:

The relevant k/community PRs are merged:
#6259
#6258

And the repo has been updated and archived: https://github.com/kubernetes/design-proposals-archive

Closing!
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/enhancements Issues or PRs related to the Enhancements subproject kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/feature Categorizes issue or PR as related to a new feature. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.
Projects
None yet
Development

No branches or pull requests