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.

Sign up for GitHub

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

Jump to bottom

Add DEP template, restructure docs #659

Merged
merged 3 commits into from
Aug 16, 2023
Merged

Add DEP template, restructure docs #659

merged 3 commits into from
Aug 16, 2023

Conversation

shreyas-s-rao
Copy link
Contributor

@shreyas-s-rao shreyas-s-rao commented Aug 7, 2023 •
edited
Loading

How to categorize this PR?

/area documentation
/kind enhancement

What this PR does / why we need it:
Add DEP template, restructure multi-node etcd clusters proposal to DEP-01. Also restructure other files in docs folder:

  • Consolidated compaction-metrics.md and multinode-metrics.md into a single docs/operations/metrics.md doc
  • Replace _ with - in doc filenames
  • Restructure docs/proposals section:
    • Add DEP (Druid Enhancement Proposal) template, for proposals of large design changes in etcd-druid
    • Multi-node etcd proposal becomes DEP-01
    • Snapshot compaction becomes DEP-02
    • Scale-up of single-node to multi-node etcd cluster becomes DEP-03
  • Replace occurrences of ETCD with Etcd or etcd, since ETCD is not an abbreviation, and should not be used in all-caps

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Release note:

Introduce DEPs (Druid Enhancement Proposals) for proposing large design changes in etcd-druid.

@shreyas-s-rao shreyas-s-rao added this to the v0.20.0 milestone Aug 7, 2023
@shreyas-s-rao shreyas-s-rao requested a review from a team as a code owner August 7, 2023 16:12
@gardener-robot gardener-robot added area/documentation Documentation related kind/enhancement Enhancement, improvement, extension needs/review Needs review size/s Size of pull request is small (see gardener-robot robot/bots/size.py) labels Aug 7, 2023
@gardener-robot-ci-2 gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 7, 2023
@gardener-robot-ci-3 gardener-robot-ci-3 added needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Aug 7, 2023
@shreyas-s-rao
Copy link
Contributor Author

@shafeeqes addressed, PTAL

@gardener-robot-ci-1 gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Aug 8, 2023
@shreyas-s-rao shreyas-s-rao mentioned this pull request Aug 8, 2023
Merged
@gardener-robot gardener-robot added the needs/rebase Needs git rebase label Aug 8, 2023
@gardener-robot
Copy link

@shreyas-s-rao You need rebase this pull request with latest master branch. Please check.

@gardener-robot gardener-robot added size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) and removed size/s Size of pull request is small (see gardener-robot robot/bots/size.py) labels Aug 8, 2023
@gardener-robot-ci-2 gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 8, 2023
@gardener-robot-ci-3 gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 8, 2023
@gardener-robot gardener-robot added size/l Size of pull request is large (see gardener-robot robot/bots/size.py) needs/second-opinion Needs second review by someone else and removed size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) labels Aug 8, 2023
@gardener-robot-ci-1 gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 8, 2023
@shreyas-s-rao shreyas-s-rao requested a review from shafeeqes August 8, 2023 08:06
@gardener-robot-ci-1 gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 8, 2023
@shreyas-s-rao shreyas-s-rao changed the title Add DEP template, restructure multi-node etcd clusters proposal to DEP-01 Add DEP template, restructure docs Aug 8, 2023
@shreyas-s-rao
Copy link
Contributor Author

/retest

@shreyas-s-rao
Copy link
Contributor Author

/test pull-etcd-druid-e2e-kind-alpha-features

@aaronfern
Copy link
Contributor

/retest-required

aaronfern
aaronfern approved these changes Aug 10, 2023
View reviewed changes
Copy link
Contributor

@aaronfern aaronfern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!
One minor nit, else all good

/lgtm

docs/operations/metrics.md Outdated Show resolved Hide resolved
@gardener-robot gardener-robot added reviewed/lgtm Has approval for merging and removed needs/rebase Needs git rebase needs/review Needs review needs/second-opinion Needs second review by someone else labels Aug 10, 2023
@gardener-robot-ci-2 gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 10, 2023
@aaronfern
Copy link
Contributor

/test pull-etcd-druid-e2e-kind-alpha-features

@gardener-robot gardener-robot added needs/second-opinion Needs second review by someone else and removed reviewed/lgtm Has approval for merging labels Aug 11, 2023
@shreyas-s-rao
Copy link
Contributor Author

@aaronfern addressed, along with few more replacements of ETCD with etcd, since ETCD is technically the incorrect term to use since it isn't an abbreviation. PTAL

@gardener-robot-ci-2 gardener-robot-ci-2 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 11, 2023
aaronfern
aaronfern approved these changes Aug 11, 2023
View reviewed changes
Copy link
Contributor

@aaronfern aaronfern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!
/lgtm

@gardener-robot gardener-robot added reviewed/lgtm Has approval for merging and removed needs/second-opinion Needs second review by someone else labels Aug 11, 2023
@gardener-robot-ci-2 gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Aug 11, 2023
@shreyas-s-rao shreyas-s-rao merged commit a87c52f into gardener:master Aug 16, 2023
@shreyas-s-rao shreyas-s-rao deleted the dep/template branch August 16, 2023 15:01
@gardener-robot gardener-robot added the status/closed Issue is closed (either delivered or triaged) label Aug 16, 2023
@ishan16696
Copy link
Member

Scale-up of single-node to multi-node etcd cluster becomes DEP-03

Scale-up has already been implemented and it's a feature now.
I don't get it why you have put it in proposals ? It's no longer proposal anymore.

@shreyas-s-rao
Copy link
Contributor Author

@ishan16696 It's a design doc, and design is usually documented in proposals, since the general flow is to create a proposal with design changes and then implement it. Additionally, since the scale-up logic was changed from the original multi-node proposal, it should either be added as an amendment/edit to the multi-node proposal itself, or as a new proposal that overwrites certain sections of the original multi-node proposal. Hence, I added it to the Proposals section.

@shreyas-s-rao shreyas-s-rao self-assigned this Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aaronfern aaronfern aaronfern approved these changes

@shafeeqes shafeeqes Awaiting requested review from shafeeqes

Assignees

@shreyas-s-rao shreyas-s-rao

Labels
area/documentation Documentation related kind/enhancement Enhancement, improvement, extension needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) reviewed/lgtm Has approval for merging reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) size/l Size of pull request is large (see gardener-robot robot/bots/size.py) status/closed Issue is closed (either delivered or triaged)
Projects
None yet
Milestone
v0.20.0
Development

Successfully merging this pull request may close these issues.
8 participants
@shreyas-s-rao @gardener-robot @aaronfern @ishan16696 @shafeeqes @gardener-robot-ci-1 @gardener-robot-ci-2 @gardener-robot-ci-3