From 8b6d06650f678c97299d723658d610a7ee39ba5d Mon Sep 17 00:00:00 2001 From: Yash Pimple Date: Wed, 17 Jan 2024 13:36:35 +0000 Subject: [PATCH 1/4] docs: resolved Signed-off-by: Yash Pimple --- .github/actions/spelling/expect.txt | 1 + .../general/contrib-guidelines-gen.md | 14 ++++++ .../contribute/general/refinement-guide.md | 49 +++++++++++++++++++ 3 files changed, 64 insertions(+) create mode 100644 docs-new/docs/contribute/general/refinement-guide.md diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 7e243586b7..1f87349531 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -258,6 +258,7 @@ ikbr imagepullsecret IManager IMeter +inclusivity Infof inlines Intelli diff --git a/docs-new/docs/contribute/general/contrib-guidelines-gen.md b/docs-new/docs/contribute/general/contrib-guidelines-gen.md index 572d436361..496f3a44ec 100644 --- a/docs-new/docs/contribute/general/contrib-guidelines-gen.md +++ b/docs-new/docs/contribute/general/contrib-guidelines-gen.md @@ -43,3 +43,17 @@ please create an issue on the GitHub repository. * If you want to do the work on an issue, include that information in your description of the issue or in a comment to the issue. + +## Proposing new work + +* Create and refine a ticket + * When proposing new work, start by creating an issue or ticket in the project's + [issue tracker](https://github.com/keptn/lifecycle-toolkit/issue). + * Actively participate in the refinement meetings sessions that are part of the weekly + [community meetings](https://community.cncf.io/keptn-community/). + * In these sessions, everyone discusses the proposed work, whether it is a good idea, + what exactly should be done and how it aligns with project goals. + * After the discussions, maintainers engage in a process known as **Scrum Poker**. + This involves a voting mechanism where maintainers collectively assess the size + and complexity of the proposed work, helping to decide whether it should proceed. + \ No newline at end of file diff --git a/docs-new/docs/contribute/general/refinement-guide.md b/docs-new/docs/contribute/general/refinement-guide.md new file mode 100644 index 0000000000..bdf44b74ac --- /dev/null +++ b/docs-new/docs/contribute/general/refinement-guide.md @@ -0,0 +1,49 @@ +# Refinement timeblock + +During Refinement timeblock, maintainers engage in technical +discussions on open issues and pull requests. +This dedicated time allows for in-depth conversations, knowledge sharing, +and collective decision-making. +It is an opportunity for the team to synchronize their understanding of +ongoing developments, address challenges, and ensure a common vision for the project. + +**Purpose and goals:** + +- **Alignment:** Ensure a shared understanding among maintainers regarding ongoing +developments, project goals, and upcoming tickets. +- **Technical Depth:** Delve into the technical aspects of open issues and pull +requests, facilitating a deeper understanding of proposed Pull requests. +- **Decision-Making:** Make collective decisions on the adoption of new features, +changes, and improvements based on technical merit. + +This process aligns with our commitment to open-source principles, ensuring that +technical discussions are inclusive, transparent, and beneficial for the +entire Keptn community. + +## Contributor guidance + +Contributors proposing new features are encouraged to participate in +[refinement meetings](https://community.cncf.io/keptn-community/) related +to their contributions. +This provides valuable insights into ongoing technical discussions and +aligns their efforts with the broader project vision. +Follow these steps: + +1. Review the project's [contributing guide](../docs/contrib-guidelines-docs.md) +for information on upcoming refinement meetings. +1. Attend relevant refinement meetings to present and discuss proposed features. +1. Actively engage in technical discussions, seeking feedback and guidance from +maintainers. +1. Iteratively refine contributions based on insights gained during meetings. + +By following this process, contributors contribute not only code but also valuable +perspectives and insights, fostering a collaborative and innovative +community environment. + +## Outcome + +- Shared understanding among maintainers and contributors on ongoing developments. +- Improved contributions via collaborative discussions and refinement. +- Documented decisions and action items for future reference in project documentation. +This refined process aligns with our commitment to open-source principles, ensuring +transparency, inclusivity, and technical excellence within the Keptn community. From 99646f99a8b9184092bfb4c6d09b8b01ce7a2aa4 Mon Sep 17 00:00:00 2001 From: Yash Pimple Date: Wed, 17 Jan 2024 13:48:15 +0000 Subject: [PATCH 2/4] fix: spelling and htmltest eror Signed-off-by: Yash Pimple --- .github/actions/spelling/expect.txt | 1 + docs-new/docs/contribute/general/contrib-guidelines-gen.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 1f87349531..e4a48b9e0c 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -621,6 +621,7 @@ teststep tgz thisthatdc thschue +timeblock timeframe Timerange timeseries diff --git a/docs-new/docs/contribute/general/contrib-guidelines-gen.md b/docs-new/docs/contribute/general/contrib-guidelines-gen.md index 496f3a44ec..19cf3bac0e 100644 --- a/docs-new/docs/contribute/general/contrib-guidelines-gen.md +++ b/docs-new/docs/contribute/general/contrib-guidelines-gen.md @@ -48,7 +48,7 @@ please create an issue on the GitHub repository. * Create and refine a ticket * When proposing new work, start by creating an issue or ticket in the project's - [issue tracker](https://github.com/keptn/lifecycle-toolkit/issue). + [issue tracker](https://github.com/keptn/lifecycle-toolkit/issues). * Actively participate in the refinement meetings sessions that are part of the weekly [community meetings](https://community.cncf.io/keptn-community/). * In these sessions, everyone discusses the proposed work, whether it is a good idea, From ea620bac477f6c758c004ae4d6bdd71b69f1f651 Mon Sep 17 00:00:00 2001 From: Yash Pimple Date: Wed, 17 Jan 2024 14:22:27 +0000 Subject: [PATCH 3/4] fix: docs Signed-off-by: Yash Pimple --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index fa8de59344..16039a5d97 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -171,6 +171,7 @@ nav: - Create PR: docs/contribute/general/git/pr-create.md - PR review process: docs/contribute/general/git/review.md - Contribution Guidelines: docs/contribute/general/contrib-guidelines-gen.md + - Refinement Timeblock: docs/contribute/general/refinement-guide.md - Software contributions: - docs/contribute/software/index.md - Software development environment: docs/contribute/software/dev-environ.md From 30ff23ccd092ebfdc83bb5cfa79549c81d900dfd Mon Sep 17 00:00:00 2001 From: Yash Pimple Date: Wed, 17 Jan 2024 15:23:05 +0000 Subject: [PATCH 4/4] fix: improvements Signed-off-by: Yash Pimple --- .github/actions/spelling/expect.txt | 1 + .../docs/contribute/general/contrib-guidelines-gen.md | 4 ++-- docs-new/docs/contribute/general/refinement-guide.md | 11 ++++++----- mkdocs.yml | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index e4a48b9e0c..71c8dd3b57 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -510,6 +510,7 @@ previousversion printargs printcolumn privs +Process proj promapi promhttp diff --git a/docs-new/docs/contribute/general/contrib-guidelines-gen.md b/docs-new/docs/contribute/general/contrib-guidelines-gen.md index 19cf3bac0e..15e6465065 100644 --- a/docs-new/docs/contribute/general/contrib-guidelines-gen.md +++ b/docs-new/docs/contribute/general/contrib-guidelines-gen.md @@ -49,10 +49,10 @@ please create an issue on the GitHub repository. * Create and refine a ticket * When proposing new work, start by creating an issue or ticket in the project's [issue tracker](https://github.com/keptn/lifecycle-toolkit/issues). - * Actively participate in the refinement meetings sessions that are part of the weekly + * Actively participate in the refinement sessions that are part of the weekly [community meetings](https://community.cncf.io/keptn-community/). * In these sessions, everyone discusses the proposed work, whether it is a good idea, - what exactly should be done and how it aligns with project goals. + what exactly should be done and how it aligns with the project goals. * After the discussions, maintainers engage in a process known as **Scrum Poker**. This involves a voting mechanism where maintainers collectively assess the size and complexity of the proposed work, helping to decide whether it should proceed. diff --git a/docs-new/docs/contribute/general/refinement-guide.md b/docs-new/docs/contribute/general/refinement-guide.md index bdf44b74ac..3454077de1 100644 --- a/docs-new/docs/contribute/general/refinement-guide.md +++ b/docs-new/docs/contribute/general/refinement-guide.md @@ -1,6 +1,6 @@ -# Refinement timeblock +# Refinement process -During Refinement timeblock, maintainers engage in technical +During the Refinement timeblock in community meetings, maintainers engage in technical discussions on open issues and pull requests. This dedicated time allows for in-depth conversations, knowledge sharing, and collective decision-making. @@ -23,13 +23,13 @@ entire Keptn community. ## Contributor guidance Contributors proposing new features are encouraged to participate in -[refinement meetings](https://community.cncf.io/keptn-community/) related -to their contributions. +refinement sessions during [community meetings](https://community.cncf.io/keptn-community/) to talk +about their contributions. This provides valuable insights into ongoing technical discussions and aligns their efforts with the broader project vision. Follow these steps: -1. Review the project's [contributing guide](../docs/contrib-guidelines-docs.md) +1. Review the project's [contributing guide](../index.md) for information on upcoming refinement meetings. 1. Attend relevant refinement meetings to present and discuss proposed features. 1. Actively engage in technical discussions, seeking feedback and guidance from @@ -45,5 +45,6 @@ community environment. - Shared understanding among maintainers and contributors on ongoing developments. - Improved contributions via collaborative discussions and refinement. - Documented decisions and action items for future reference in project documentation. + This refined process aligns with our commitment to open-source principles, ensuring transparency, inclusivity, and technical excellence within the Keptn community. diff --git a/mkdocs.yml b/mkdocs.yml index 16039a5d97..bb9ed969d4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -171,7 +171,7 @@ nav: - Create PR: docs/contribute/general/git/pr-create.md - PR review process: docs/contribute/general/git/review.md - Contribution Guidelines: docs/contribute/general/contrib-guidelines-gen.md - - Refinement Timeblock: docs/contribute/general/refinement-guide.md + - Refinement Process: docs/contribute/general/refinement-guide.md - Software contributions: - docs/contribute/software/index.md - Software development environment: docs/contribute/software/dev-environ.md