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

api.yml menu is hardcoded #814

Open
Fryguy opened this issue Mar 23, 2020 · 4 comments
Open

api.yml menu is hardcoded #814

Fryguy opened this issue Mar 23, 2020 · 4 comments

Comments

@Fryguy
Copy link
Member

Fryguy commented Mar 23, 2020

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

@Fryguy
Copy link
Member Author

Fryguy commented Mar 23, 2020

cc @abellotti @bdunne

@Fryguy Fryguy added the bug label Mar 23, 2020
@chessbyte
Copy link
Member

@Fryguy are you referring to this file?

@Fryguy
Copy link
Member Author

Fryguy commented Apr 6, 2020

@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.

@Fryguy
Copy link
Member Author

Fryguy commented Oct 20, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants