-
Notifications
You must be signed in to change notification settings - Fork 118
Update usage types in the docs #504
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
base: 4.19
Are you sure you want to change the base?
Conversation
@blueorangutan docbuild |
@sureshanaparti a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/504. (QA-JID 339) |
@rajujith Update the usage types (still the record formats for these to be updated) |
@blueorangutan docbuild |
@sureshanaparti a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/504. (QA-JID 342) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
quite frankly I am against this change. there is a list usage types API and it should document the usage types. adding/updating the docs on this in creating a split source of truth. |
@DaanHoogland, The doc in its current form has already diverged from the source of truth, so adding the missing usage types wouldn’t introduce any additional inconsistency. As a potential improvement, perhaps we could sync the doc with the missing Usage Types and clearly mention that users should refer to the list Usage Types API for the most up-to-date information? I was hoping to add some details related to Backup usage to the doc, but currently, Backup isn’t even mentioned as a usage type. |
This PR updates/sync the usage types in docs with the API response and code.
Fixes apache/cloudstack#10813
Current doc: https://docs.cloudstack.apache.org/en/latest/adminguide/usage.html#usage-types.
list usagetypes API response =>
code =>
https://github.com/apache/cloudstack/blob/39c5641cbe674b19bc77082b850565f634a7cb84/api/src/main/java/org/apache/cloudstack/usage/UsageTypes.java#L24-L50
📚 Documentation preview 📚: https://cloudstack-documentation--504.org.readthedocs.build/en/504/