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

Docforge manifest doesn't render all pages under docs #828

Open
ashwani2k opened this issue Jun 12, 2023 · 0 comments
Open

Docforge manifest doesn't render all pages under docs #828

ashwani2k opened this issue Jun 12, 2023 · 0 comments
Labels
area/documentation Documentation related kind/bug Bug lifecycle/rotten Nobody worked on this for 12 months (final aging stage) priority/2 Priority (lower number equals higher priority)

Comments

@ashwani2k
Copy link
Contributor

How to categorize this issue?

/area documentation
/kind bug
/priority 2

What happened:
Currently the documentation for MCM doesn't reflect the actual docs available in the repo:

  • Readme.md is not renderend on the landing page of mcm.
  • Other doc structure like FAQ are not rendered as the nodeSelectors are explicitly define and there the manifest doesn't have a section for FAQ.

What you expected to happen:
Ideally we should remove this hard coupling to the structure and lets the docs be rendered as captured under the docs folder. This ensures that any future re-structuring of DOCs doesn't require explicit docforge handling.

How to reproduce it (as minimally and precisely as possible):
Just follow the links and reference the /docs folder to see the differences.

Anything else we need to know?:

Environment:

  • Kubernetes version (use kubectl version):
  • Cloud provider or hardware configuration:
  • Others:
@ashwani2k ashwani2k added the kind/bug Bug label Jun 12, 2023
@gardener-robot gardener-robot added area/documentation Documentation related priority/2 Priority (lower number equals higher priority) labels Jun 12, 2023
@gardener-robot gardener-robot added the lifecycle/stale Nobody worked on this for 6 months (will further age) label Feb 19, 2024
@gardener-robot gardener-robot added lifecycle/rotten Nobody worked on this for 12 months (final aging stage) and removed lifecycle/stale Nobody worked on this for 6 months (will further age) labels Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related kind/bug Bug lifecycle/rotten Nobody worked on this for 12 months (final aging stage) priority/2 Priority (lower number equals higher priority)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants