Charmhub docs should explain how to provide the tool resource

[Andy Wu]

charm resource tools.zip has 0 size from latest/stable (rev 30) , edge channel (revision 31), series jammy

ubuntu@jppdmaas001:~/ceph-build$ juju resources hw-health
Resource Supplied by Revision
tools charmstore 0

https://charmhub.io/hw-health/resources/tools

some tools like megacli will be installed from tools.zip by default , but failed with BadZipFile error

2023-06-16 18:21:27 INFO unit.hw-health/3.juju-log server.go:316 nrpe-external-master:97: status-set: maintenance: Installing tool MegaCLI
2023-06-16 18:21:27 ERROR unit.hw-health/3.juju-log server.go:316 nrpe-external-master:97: BadZipFile: File is not a zip file

As the result, nagios will show unknown status for megacli related check simply because the megacli is not installed

[Andrea Ieri (aieri)]

this is actually intended behavior: users must assemble their own resource after having downloaded the vendor binaries from their respective sources and agreed to their specific EULAs.

The bug is however still valid since this behavior is documented in the README.md file, which is no longer shown at https://charmhub.io/hw-health

[Nicholas Malacarne (nicholas-malacarne)]

It seems like there needs to be docs index page for the charm [0]. Once the docs index page exists the url can be added to metadata.yaml under the docs key [1]. Unfortunately I can not log into the charmhub discourse.

[0] https://juju.is/docs/sdk/add-docs-to-your-charmhub-page#heading--create-docs-for-your-charm-on-discourse
[1] https://github.com/canonical/nginx-ingress-integrator-operator/blob/754d3a7c3bb5f8a306f687972bd313d0cdcd6e55/metadata.yaml#L7

[Ashley James (dashmage)]

The details are visible on the charmhub page for the edge channel now [1]. Once the build is promoted to the stable channel, it will be visible on the main page [2].

[1]: https://charmhub.io/hw-health?channel=edge
[2]: https://charmhub.io/hw-health