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: update HtmlTest and API docs generator for new docs page #2651

Merged
merged 14 commits into from
Dec 12, 2023

Conversation

mowies
Copy link
Member

@mowies mowies commented Dec 7, 2023

This PR

  • adjusts the API docs generator to generate files for the docs-new folder with adjusted markdown headings and filenames
  • moves the docs-build and docs-serve make commands to the newly created docs-new/Makefile along with other things needed from the old docs/Makefile
  • adds a few data-proofer-ignore HTML attributes to the theme override files to have those HTML tags be ignored by HtmlTest

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 7, 2023
Copy link

netlify bot commented Dec 7, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 427715c
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/657851944727810008439cb0
😎 Deploy Preview https://deploy-preview-2651--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Dec 7, 2023

Codecov Report

Merging #2651 (4a978b5) into main (928b546) will decrease coverage by 0.04%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2651      +/-   ##
==========================================
- Coverage   85.48%   85.44%   -0.04%     
==========================================
  Files         155      155              
  Lines       10175    10175              
==========================================
- Hits         8698     8694       -4     
- Misses       1198     1201       +3     
- Partials      279      280       +1     

see 1 file with indirect coverage changes

Flag Coverage Δ
certificate-operator 67.43% <ø> (ø)
component-tests 56.08% <ø> (-0.28%) ⬇️
lifecycle-operator 84.44% <ø> (ø)
metrics-operator 87.43% <ø> (ø)
scheduler 36.53% <ø> (ø)

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

@github-actions github-actions bot added the ops label Dec 11, 2023
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
# Conflicts:
#	Makefile
#	docs-new/docs/reference/api-reference/lifecycle/index.md
#	docs-new/docs/reference/api-reference/metrics/index.md
#	docs-new/docs/reference/api-reference/options/index.md
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
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
0.0% 0.0% Duplication

@mowies mowies marked this pull request as ready for review December 12, 2023 12:55
@mowies mowies requested a review from a team as a code owner December 12, 2023 12:55
@mowies mowies changed the title docs: update HtmlTest for new docs page docs: update HtmlTest and API docs generator for new docs page Dec 12, 2023
@mowies mowies merged commit 74f3cf9 into keptn:main Dec 12, 2023
41 checks passed
@mowies mowies deleted the adapt-htmltest branch December 12, 2023 13:14
aryasoni98 pushed a commit to aryasoni98/lifecycle-toolkit that referenced this pull request Dec 13, 2023
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.

3 participants