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

Copy content to new docs page #2553

Closed
Tracked by #2545
mowies opened this issue Nov 23, 2023 · 0 comments · Fixed by #2605
Closed
Tracked by #2545

Copy content to new docs page #2553

mowies opened this issue Nov 23, 2023 · 0 comments · Fixed by #2605
Assignees
Labels
docs-infrastructure Issues related to the look and feel of the docs documentation Improvements or additions to documentation
Milestone

Comments

@mowies
Copy link
Member

mowies commented Nov 23, 2023

Goal

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 "<file>" %}.
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).

DoD

  • content copied
  • frontmatter replaced (examples in PoC)
  • links work
  • include shortcodes work (examples in PoC)

Notes

@mowies mowies added documentation Improvements or additions to documentation docs-infrastructure Issues related to the look and feel of the docs labels Nov 23, 2023
@mowies mowies added this to the 0.11 milestone Nov 23, 2023
@mowies mowies added status: ready-for-refinement Issue is relevant for the next backlog refinment and removed status: ready-for-refinement Issue is relevant for the next backlog refinment labels Nov 23, 2023
@mowies mowies moved this to 🎟️ Refined in Keptn Lifecycle Toolkit Nov 27, 2023
@thisthat thisthat self-assigned this Nov 29, 2023
@github-project-automation github-project-automation bot moved this from 🎟️ Refined to ✅ Done in Keptn Lifecycle Toolkit Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-infrastructure Issues related to the look and feel of the docs documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants