Docforge manifest doesn't render all pages under docs
ashwani2k opened this issue · 0 comments
ashwani2k commented
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: