-
Notifications
You must be signed in to change notification settings - Fork 104
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
api.yml menu is hardcoded #814
Comments
@chessbyte Yes. Anytime a new section is added or removed over in manageiq_docs for the API, someone has to remember to come here and also add it to the yml. Feels like we need a way to autogenerate that from the content in manageiq_docs instead. |
I've been thinking about this and I think the better approach is to have the menu in the documentation repo itself (menu file per branch)...Then it can be added as part of the PR that introduces the doc. I don't think we should autogenerate, because then we can't control the order of documents. However, we may want to introduce a test/warning if a document is created but not in the menu. This way the PR author can choose to add it to the menu or put it in a "known hidden" list. |
The api.yml drives the left side menu, but it is hardcoded, and the actual api docs live over in manageiq_docs. As such, changes are required in 2 repos. Instead we should probably autogenerate at build time.
cc @apinnick
The text was updated successfully, but these errors were encountered: