Skip to content

Conversation

@chanchiwai-ray
Copy link
Contributor

@chanchiwai-ray chanchiwai-ray commented Sep 11, 2024

Update docs for ARM and AMD resources:

  • perccli and sas2ircu are not available for arm. We simply explain these resources are only available to AMD64 servers.
  • storcli and sas3ircu support arm, updated the docs with relevant path.
  • update storcli version in the description

superseded: #295
depends on: #303

@chanchiwai-ray
Copy link
Contributor Author

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 checksum.py. What do you think?

jneo8
jneo8 previously approved these changes Sep 11, 2024
@samuelallan72
Copy link

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 checksum.py

Agreed, this sounds like a good method. 👍

Copy link
Contributor

@aieri aieri left a 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).

@chanchiwai-ray
Copy link
Contributor Author

chanchiwai-ray commented Sep 11, 2024

Since juju charm-resources hardware-observer --format yaml can print the resource description as it is (better looking than the one in charmbub resource page), we can preserve the description here

@chanchiwai-ray chanchiwai-ray changed the title Update resource documentation to point to the source of truth. Update resource documentation Sep 11, 2024
@chanchiwai-ray
Copy link
Contributor Author

Will need to wait until #303 is merged

@chanchiwai-ray chanchiwai-ray merged commit 2d41d8f into main Sep 13, 2024
4 checks passed
@chanchiwai-ray chanchiwai-ray deleted the update-resource-docs branch September 13, 2024 02:17
@Pjack Pjack mentioned this pull request Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants