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

chore: introduce dev environment setup for documentation #2609

Merged
merged 14 commits into from
Dec 1, 2023
Merged

chore: introduce dev environment setup for documentation #2609

merged 14 commits into from
Dec 1, 2023

Conversation

odubajDT
Copy link
Contributor

Summary

  • adds dev environment setup for new documentation
  • adds contributing info
  • adapts makefile to run dev env

Fixes #2555

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

netlify bot commented Nov 29, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 27a7d47
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/65674071fdf72a000879279e
😎 Deploy Preview https://deploy-preview-2609--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 Nov 29, 2023

Codecov Report

Merging #2609 (0c66986) into main (fbd4601) will decrease coverage by 0.04%.
Report is 5 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2609      +/-   ##
==========================================
- 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.

@odubajDT odubajDT marked this pull request as ready for review November 29, 2023 13:59
@odubajDT odubajDT requested a review from a team as a code owner November 29, 2023 13:59
@odubajDT odubajDT changed the title chore: introduce dev environment for documentation chore: introduce dev environment setup for documentation Nov 29, 2023
Makefile Outdated Show resolved Hide resolved
docs-new/Makefile Outdated Show resolved Hide resolved
docs-new/Makefile Outdated Show resolved Hide resolved
docs-new/docs/assets/higher-compliance.png Outdated Show resolved Hide resolved
docs-new/docs/assets/javascripts/versions.js Outdated Show resolved Hide resolved
docs-new/docs/assets/keptn-icon-white.svg Outdated Show resolved Hide resolved
docs-new/docs/assets/stylesheets/home.css Outdated Show resolved Hide resolved
docs-new/docs/assets/stylesheets/versions.css Outdated Show resolved Hide resolved
docs-new/docs/documentation/index.md Outdated Show resolved Hide resolved
docs-new/mkdocs.yaml Outdated Show resolved Hide resolved
docs-new/Makefile Outdated Show resolved Hide resolved
docs-new/Makefile Outdated Show resolved Hide resolved
docs-new/Makefile Outdated Show resolved Hide resolved
odubajDT and others added 7 commits November 30, 2023 11:39
Signed-off-by: odubajDT <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Signed-off-by: odubajDT <[email protected]>
@github-actions github-actions bot added the ops label Nov 30, 2023
docs-new/Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
docs-new/CONTRIBUTING.md Outdated Show resolved Hide resolved
docs-new/CONTRIBUTING.md Outdated Show resolved Hide resolved
docs-new/CONTRIBUTING.md Outdated Show resolved Hide resolved
docs-new/CONTRIBUTING.md Outdated Show resolved Hide resolved
odubajDT and others added 3 commits November 30, 2023 14:23
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Signed-off-by: odubajDT <[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.

for renovate to work, the version variable needs to only contain the version number

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: odubajDT <[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.2% 0.2% Duplication

@odubajDT odubajDT merged commit bc0f1d3 into keptn:main Dec 1, 2023
39 checks passed
ahmedavid pushed a commit to ahmedavid/lifecycle-toolkit that referenced this pull request Dec 6, 2023
Signed-off-by: odubajDT <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: odubajDT <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: David Ahmadov <[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 ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update makefiles to work with new docs engine
4 participants