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: copy content to new docs engine #2605

Merged
merged 19 commits into from
Nov 30, 2023

Conversation

thisthat
Copy link
Member

@thisthat thisthat commented Nov 29, 2023

Description

  • Copy over the content from the old docs page (docs) to the new page (docs-new).
  • Make sure that the front matter form the old pages is replaced with just a markdown h1/# title.
  • Make sure that links still work (mkdocs serve or mkdocs build will tell you).
    embed and docsembed hugo shortcodes need to be replaced with {% include "" %}.
  • Every folder needs an index.md file which needs to be added where a file doesn't exist yet. Just add a title in there for now.
  • The navigation sidebar should be set up in the mkdocs.yml file under the nav: key (check PoC for example). -> will do a follow-up for this so we can discuss

Fixes #2553

Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
@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 d28cd69
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/65679ce92d94f00008092ac0
😎 Deploy Preview https://deploy-preview-2605--keptn-lifecycle-toolkit.netlify.app/docs/migrate/metrics-observe
📱 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 #2605 (44a2070) into main (fbd4601) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2605   +/-   ##
=======================================
  Coverage   85.48%   85.48%           
=======================================
  Files         155      155           
  Lines       10175    10175           
=======================================
  Hits         8698     8698           
  Misses       1198     1198           
  Partials      279      279           
Flag Coverage Δ
certificate-operator 67.43% <ø> (ø)
component-tests 56.36% <ø> (ø)
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.

Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
@thisthat thisthat changed the title move folder docs: copy content to new docs engine Nov 29, 2023
thisthat and others added 6 commits November 29, 2023 16:03
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
@github-actions github-actions bot added the ops label Nov 29, 2023
@thisthat thisthat marked this pull request as ready for review November 29, 2023 20:54
@thisthat thisthat requested review from a team as code owners November 29, 2023 20:54
thisthat and others added 2 commits November 29, 2023 22:08
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
@StackScribe
Copy link
Contributor

Whoops, I started commenting on stuff like stacked headers and I see page titles I don't like but that should not be part of this exercise, right? Make sure that each page has an H1 and we can fix the rest later...

@thisthat
Copy link
Member Author

Whoops, I started commenting on stuff like stacked headers and I see page titles I don't like but that should not be part of this exercise, right? Make sure that each page has an H1 and we can fix the rest later...

@StackScribe yes, we can do a follow-up that fixes these :)
I would be fast in merging this PR and transition everything to the new engine so we don't block other content PR :)

docs-new/docs/404/index.md Outdated Show resolved Hide resolved
docs-new/docs/contribute/general/dco/index.md Show resolved Hide resolved
docs-new/tmp/go.mod Outdated Show resolved Hide resolved
Signed-off-by: Giovanni Liva <[email protected]>
Signed-off-by: Giovanni Liva <[email protected]>
Copy link

SonarCloud Quality Gate failed.    Quality Gate failed

Bug C 1 Bug
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 3 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@thisthat thisthat merged commit 7a4239f into keptn:main Nov 30, 2023
38 of 39 checks passed
ahmedavid pushed a commit to ahmedavid/lifecycle-toolkit that referenced this pull request Dec 6, 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.

Copy content to new docs page
3 participants