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

[Tracking] Website Overhaul #2545

Closed
11 of 12 tasks
mowies opened this issue Nov 23, 2023 · 1 comment
Closed
11 of 12 tasks

[Tracking] Website Overhaul #2545

mowies opened this issue Nov 23, 2023 · 1 comment
Assignees
Labels
docs-infrastructure Issues related to the look and feel of the docs epic
Milestone

Comments

@mowies
Copy link
Member

mowies commented Nov 23, 2023

Goal

We want to have a new website that is built on top of a new site generator that will make maintenance and setup of docs much simpler. Additionally, a new hosting provider should be used so that hosting of the website will be easier as well.

Details

After the initial research done in #2458, the plan is to move the docs to MkDocs and use the Material for MkDocs theme which comes with lots of extra features that take work off of the team's hands when it comes to customization of the website.
For hosting, ReadTheDocs will be used since it provides features that are tailored towards technical documentation which again, will make maintainability better.

Versioning of the website will be removed from the website for now since the project doesn't really need it except for certain specific pages like the Upgrade page.

PoC for this epic with a fully working setup: https://github.com/mowies/mkdocs-testing
The corresponding website can be accessed here: https://mkdocs-testing.readthedocs.io/en/stable/
The corresponding ReadTheDocs project can be accessed here: https://readthedocs.org/projects/mkdocs-testing/

Tasks

Preview Give feedback
  1. docs-infrastructure
    mowies
  2. docs-infrastructure
    mowies
  3. docs-infrastructure documentation
    thisthat
  4. docs-infrastructure
    mowies
  5. docs-infrastructure
    odubajDT
  6. docs-infrastructure good first issue
    prakrit55
  7. docs-infrastructure
    mowies
  8. documentation
    mowies
  9. documentation good first issue
  10. documentation
    mowies
  11. docs-infrastructure
  12. docs-infrastructure documentation
    mowies
@mowies mowies added the epic label Nov 23, 2023
@mowies mowies added this to the 0.11 milestone Nov 23, 2023
@mowies mowies moved this to 🏗 Shaping in Keptn Lifecycle Toolkit Nov 23, 2023
@mowies mowies self-assigned this Nov 23, 2023
@mowies mowies added docs-infrastructure Issues related to the look and feel of the docs status: ready-for-refinement Issue is relevant for the next backlog refinment labels Nov 23, 2023
@mowies mowies changed the title [Tracking] New website [Tracking] Website Overhaul Nov 23, 2023
@mowies mowies removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Nov 27, 2023
@mowies mowies modified the milestones: 0.11, 0.10 Dec 19, 2023
@mowies
Copy link
Member Author

mowies commented Jan 22, 2024

Closing this since everything is done except for one issue, that will hopefully be done by the community

@mowies mowies closed this as completed Jan 22, 2024
@github-project-automation github-project-automation bot moved this from 🏗 Shaping to ✅ Done in Keptn Lifecycle Toolkit Jan 22, 2024
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 epic
Projects
Archived in project
Development

No branches or pull requests

1 participant