-
Notifications
You must be signed in to change notification settings - Fork 17
Update resource documentation #308
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
Conversation
|
I think the resource's description should be pointing to more user-friendly pages, e.g. in charmhub https://charmhub.io/hardware-observer/docs/monitor-hw-raid-controller. And we should update the charmhub page with a list of supported resources that are automatically generated from the |
Agreed, this sounds like a good method. 👍 |
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.
While more accurate, to me this seems to be a step back from a usability perspective.
As a user, I probably care more about how to use the software than to know how it works internally, and the current descriptions are very good at concisely telling me what to do to make things work. I am definitely not against documenting which versions we accept, but I don't think it should come at the expense of very a practical "go here, do this, etc".
Additionally, 99% of the time a user probably wants to be able to sideload the latest version of these resources (and the charm not to break if they don't push a newer one when available); I would expect "I want to know if a specific version from 3 years ago" to be an exceedingly rare use case. From this point of view a list of accepted versions and checksums brings little value (and less than adding checksums for newer revisions).
|
Since |
|
Will need to wait until #303 is merged |
Update docs for ARM and AMD resources:
superseded: #295
depends on: #303