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: set up directory for CRD Reference #800

Merged
merged 3 commits into from
Feb 13, 2023
Merged

docs: set up directory for CRD Reference #800

merged 3 commits into from
Feb 13, 2023

Conversation

StackScribe
Copy link
Contributor

Signed-off-by: Meg McRoberts [email protected]

This sets up the directory and a template file for the CRD Reference pages

This is for use in Phase 1 of #778 , to allow us to develop content. This is almost certainly not how this material will ultimately be published but will provide us with valuable learning to help us determine the structure we want and implement the appropriate tooling.

@codecov
Copy link

codecov bot commented Feb 9, 2023

Codecov Report

Merging #800 (ae796d1) into main (b5c5801) will increase coverage by 0.66%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #800      +/-   ##
==========================================
+ Coverage   57.75%   58.41%   +0.66%     
==========================================
  Files          91       97       +6     
  Lines        7243     7518     +275     
==========================================
+ Hits         4183     4392     +209     
- Misses       2891     2937      +46     
- Partials      169      189      +20     
Impacted Files Coverage Δ
operator/controllers/common/providers/provider.go 80.00% <0.00%> (-20.00%) ⬇️
operator/controllers/common/providers/common.go 100.00% <0.00%> (ø)
...erator/controllers/common/providers/keptnmetric.go
...perator/controllers/common/providers/prometheus.go
operator/controllers/common/providers/dynatrace.go
...trollers/common/providers/prometheus/prometheus.go 85.36% <0.00%> (ø)
...ollers/common/providers/dynatrace/client/config.go 100.00% <0.00%> (ø)
...r/controllers/common/providers/dynatrace/common.go 100.00% <0.00%> (ø)
...ollers/common/providers/dynatrace/client/common.go 66.66% <0.00%> (ø)
...ollers/common/providers/dynatrace/client/client.go 69.31% <0.00%> (ø)
... and 4 more
Flag Coverage Δ
component-tests 42.31% <ø> (-6.09%) ⬇️
keptn-lifecycle-operator 54.50% <ø> (+0.90%) ⬆️
klt-cert-manager 67.50% <ø> (ø)
scheduler 21.17% <ø> (ø)

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

@thschue thschue changed the title doc-chore: Set up directory for CRD Reference docs: Set up directory for CRD Reference Feb 9, 2023
@thschue thschue changed the title docs: Set up directory for CRD Reference docs: set up directory for CRD Reference Feb 9, 2023
Copy link
Contributor

@thschue thschue left a comment

Choose a reason for hiding this comment

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

Thank you for the addition of this section. Added some minor comments.

docs/content/en/docs/crd-ref/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/_index.md Outdated Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Feb 9, 2023

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

Copy link
Contributor

@thschue thschue left a comment

Choose a reason for hiding this comment

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

lgtm

@thschue thschue merged commit 4748728 into keptn:main Feb 13, 2023
@keptn-bot keptn-bot mentioned this pull request Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants