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: improve landing pages for Contrib Guide #3342

Merged
merged 8 commits into from
Mar 26, 2024
Merged

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Mar 22, 2024

Summary

This PR does the following:

  • Remove "under development" disclaimer for "General" and "Software" sections of the "Contributing" guide
  • Adds brief description of the sub-sections of the "Contributing" guide on the main landing page
  • Adds brief description of the "General" section on that landing page
  • Adds brief description of the "Software contributions" section on that landing page
  • Adds some xrefs and content enhancements to "General" sub-sections

Checks

  • [n/a] 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)
  • [n/a] 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)

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Mar 22, 2024
@StackScribe StackScribe self-assigned this Mar 22, 2024
@StackScribe StackScribe requested review from a team as code owners March 22, 2024 05:52
@StackScribe StackScribe marked this pull request as draft March 22, 2024 05:59
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Copy link

sonarcloud bot commented Mar 25, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@StackScribe StackScribe marked this pull request as ready for review March 25, 2024 04:55
@odubajDT odubajDT merged commit 77b2c6d into main Mar 26, 2024
12 checks passed
@odubajDT odubajDT deleted the 0322-contrib-landing branch March 26, 2024 12:17
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: vickysomtee <vickysomtee@gmail.com>
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants