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

docs: add documentation for the refinement process in the contribute guide #2779

Merged
merged 4 commits into from
Jan 18, 2024

Conversation

YashPimple
Copy link
Member

Description

This pull request addresses the issue #2675, where the goal is to document the refinement process in the contribute guide.

Fixes #2675

Changes Made:

  • Added a new page named refinement-guide.md in the contribute/general section.
  • Updated the contribut-guidelines-gen.md file to include guidance on creating and refining tickets for proposed work.
  • Provided detailed for contributors and members on how to participate in refinement meetings and improve their contributions iteratively.

Checks

  • My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • I signed off all my commits according to the Developer Certificate of Origin (DCO)(
    see Contribution Guide)
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My content follows the style guidelines of this project (YAMLLint, markdown-lint)
  • I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my content including grammar and typo errors and also checked the rendered page
    from the Netlify deploy preview
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)

@YashPimple YashPimple requested a review from a team as a code owner January 10, 2024 08:07
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 10, 2024
@StackScribe
Copy link
Contributor

You need to resolve the spell-check errors. This is documented in an unmerged PR: #2504

@StackScribe
Copy link
Contributor

The readthedocs preview just shows a very brief bullet list but omits a lot of what you've written. Does all the text render when you build.it locally?

@StackScribe StackScribe reopened this Jan 12, 2024
@odubajDT
Copy link
Contributor

Hi @YashPimple any updates on this PR? Do you need support ?

Signed-off-by: Yash Pimple <[email protected]>
@YashPimple
Copy link
Member Author

YashPimple commented Jan 17, 2024

Hi @YashPimple any updates on this PR? Do you need support ?

Heo @odubajDT Thanks for checking in i have made the suggested changes please do have alook

@YashPimple
Copy link
Member Author

YashPimple commented Jan 17, 2024

en you build.it locally?

Hello @StackScribe the text get rendered but it does show us the output in General information about contributing section but if we search the content namedrefinement timeblock in the search box above then we are able to view the changes.

@mowies
Copy link
Member

mowies commented Jan 17, 2024

@YashPimple if you want the pages to show up, you need to add them to the nav: section in mkdocs.yml in the root of the repo :)

Signed-off-by: Yash Pimple <[email protected]>
@YashPimple
Copy link
Member Author

@YashPimple if you want the pages to show up, you need to add them to the nav: section in mkdocs.yml in the root of the repo :)

Oo

@YashPimple if you want the pages to show up, you need to add them to the nav: section in mkdocs.yml in the root of the repo :)

@YashPimple YashPimple closed this Jan 17, 2024
@YashPimple YashPimple reopened this Jan 17, 2024
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

this is great so far! I left some comments with improvements :)

docs-new/docs/contribute/general/contrib-guidelines-gen.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/general/contrib-guidelines-gen.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
docs-new/docs/contribute/general/refinement-guide.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/general/refinement-guide.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/general/refinement-guide.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/general/refinement-guide.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/general/refinement-guide.md Outdated Show resolved Hide resolved
Signed-off-by: Yash Pimple <[email protected]>
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@YashPimple
Copy link
Member Author

this is great so far! I left some comments with improvements :)

@mowies incorporated the suggested the improvements🫡

Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

LGTM!

@mowies mowies merged commit 4521e89 into keptn:main Jan 18, 2024
11 checks passed
@mowies
Copy link
Member

mowies commented Jan 18, 2024

thanks for this @YashPimple , great work!

Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document refinement process in contrib guide
4 participants