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: combine API and CRD reference index pages into one #2849

Merged

Conversation

geoffrey1330
Copy link
Member

@geoffrey1330 geoffrey1330 commented Jan 22, 2024

Fixes #2670

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)

Signed-off-by: geoffrey1330 <[email protected]>
Signed-off-by: geoffrey1330 <[email protected]>
@geoffrey1330 geoffrey1330 requested review from a team as code owners January 22, 2024 11:12
@github-actions github-actions bot added documentation Improvements or additions to documentation metrics-operator labels Jan 22, 2024
@geoffrey1330 geoffrey1330 changed the title Doc/2670/combine api crd reference page info docs: combine api crd reference page info Jan 22, 2024
Copy link

codecov bot commented Jan 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7175d11) 53.14% compared to head (012289f) 85.75%.

❗ Current head 012289f differs from pull request most recent head ddb9d8c. Consider uploading reports for the commit ddb9d8c to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2849       +/-   ##
===========================================
+ Coverage   53.14%   85.75%   +32.61%     
===========================================
  Files          22      161      +139     
  Lines        1767    10202     +8435     
===========================================
+ Hits          939     8749     +7810     
- Misses        735     1171      +436     
- Partials       93      282      +189     

see 150 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 67.42% <ø> (?)
component-tests 56.97% <ø> (+0.82%) ⬆️
lifecycle-operator 84.68% <ø> (?)
metrics-operator 87.63% <ø> (?)
scheduler 36.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@odubajDT odubajDT marked this pull request as draft January 22, 2024 11:35
@StackScribe
Copy link
Contributor

@geoffrey1330 You need to run make markdownlint-fix on your local branch then commit and push the resulting changes. I think that will fix the markdown errors you are getting.

Copy link
Contributor

@StackScribe StackScribe left a comment

Choose a reason for hiding this comment

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

Nicely done! Just a couple little wordsmithing suggestions...

geoffrey1330 and others added 3 commits January 23, 2024 08:13
Co-authored-by: Meg McRoberts <[email protected]>
Signed-off-by: Geoffrey Israel <[email protected]>
Co-authored-by: Meg McRoberts <[email protected]>
Signed-off-by: Geoffrey Israel <[email protected]>
@geoffrey1330
Copy link
Member Author

@geoffrey1330 You need to run make markdownlint-fix on your local branch then commit and push the resulting changes. I think that will fix the markdown errors you are getting.

Alright thanks.

docs/docs/reference/crd-reference/index.md Outdated Show resolved Hide resolved
docs/docs/reference/index.md Outdated Show resolved Hide resolved
geoffrey1330 and others added 2 commits January 25, 2024 11:45
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Geoffrey Israel <[email protected]>
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.

pls don't put links into headlines

docs/docs/reference/index.md Outdated Show resolved Hide resolved
docs/docs/reference/index.md Outdated Show resolved Hide resolved
docs/docs/reference/index.md Outdated Show resolved Hide resolved
geoffrey1330 and others added 4 commits January 25, 2024 14:22
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Geoffrey Israel <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Geoffrey Israel <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Geoffrey Israel <[email protected]>
@mowies mowies marked this pull request as ready for review January 25, 2024 13:44
@mowies mowies changed the title docs: combine api crd reference page info docs: combine API and CRD reference index pages into one Jan 25, 2024
mowies
mowies previously approved these changes Jan 25, 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.

LGTM

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

1 similar comment
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

@odubajDT odubajDT merged commit 9681cde into keptn:main Jan 25, 2024
10 checks passed
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
Signed-off-by: Geoffrey Israel <[email protected]>
Co-authored-by: Meg McRoberts <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: vickysomtee <[email protected]>
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.

Combine API/CRD reference page info
5 participants