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: [WIP] PoC draft of CRD reference pages #889

Closed
wants to merge 3 commits into from
Closed

docs: [WIP] PoC draft of CRD reference pages #889

wants to merge 3 commits into from

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Feb 21, 2023

This is a quick rough draft of what I envision as a reference page for a CRD, presented for discussion.

Caveats:

  • I can't get my local build to display this file so formatting errors are a possibility. I'll get this sraightened out
  • I used information in the existing docs but then made up some info that is not currently provided just as an example of the sort of info we might use. If we agree to go this way, we'll correct the info before publishing.
  • I will add some more samples to this PR but wanted to get one sample available quickly.

#778

@StackScribe StackScribe added the documentation Improvements or additions to documentation label Feb 21, 2023
@StackScribe StackScribe requested a review from mowies February 21, 2023 13:46
@StackScribe StackScribe self-assigned this Feb 21, 2023
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.

content-wise, this looks good, but i think we can put most of the content of this file into the actual docs comments in the code and then auto generate the markdown from there 🤷🏼


## Synopsis

```yaml
Copy link
Member

Choose a reason for hiding this comment

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

we have code examples of our CRDs already prepared (mostly). I would use a link here instead of actual code.
You can find the examples here: #888

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would love to embed this content in the source and have it autogenerated! But I figured I needed to hand-write a few pages to work things out and then we know what we want the tools to do.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would very much like the "Synopsis" to show on the reference page that is displayed in the documentation, with a format similar to what I have here. But it would be ideal if that were pulled from the software source so it does not need to be maintained manually! I very much like the idea of just pointing to existing examples -- that allows people to see how this CRD fits in the "big picture" as it were.

@StackScribe StackScribe marked this pull request as draft February 21, 2023 14:03
@codecov
Copy link

codecov bot commented Feb 21, 2023

Codecov Report

Merging #889 (1f60366) into main (c366739) will decrease coverage by 0.04%.
The diff coverage is n/a.

❗ Current head 1f60366 differs from pull request most recent head a1b78e7. Consider uploading reports for the commit a1b78e7 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #889      +/-   ##
==========================================
- Coverage   58.64%   58.60%   -0.04%     
==========================================
  Files          97       97              
  Lines        7552     7552              
==========================================
- Hits         4429     4426       -3     
- Misses       2933     2935       +2     
- Partials      190      191       +1     
Impacted Files Coverage Δ
...ator/controllers/lifecycle/keptntask/controller.go 54.94% <0.00%> (-3.30%) ⬇️
Flag Coverage Δ
component-tests 42.20% <ø> (-0.14%) ⬇️
keptn-lifecycle-operator 54.67% <ø> (ø)
klt-cert-manager 67.50% <ø> (ø)
scheduler 21.17% <ø> (ø)

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

Signed-off-by: Meg McRoberts <[email protected]>
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@StackScribe
Copy link
Contributor Author

This PR is superceded by #1083 .

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.

2 participants