DaanHoogland commented on PR #504: URL: https://github.com/apache/cloudstack-documentation/pull/504#issuecomment-3158290545
@abh1sar , > > 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. I do not believe that is a reason to let it like this. I think the paragraph should be removed and replaced with a link/command to retrieve the data from the API. We are creating a path to continuous maintenance and probably technical debt if we allow for documentation of things which are also documented in code. > 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? If this is implemented in an update script we still need to have it run and humans will forget. > > 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. That should be solved in the source (i.e. the API doc, not in this file) cc @Pearl1594 @sureshanaparti @rajujith -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@cloudstack.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
