31. Set up URL redirect to user docs
In the output of the pre-refresh-check action, charm-refresh will display a URL to the charm’s user documentation for in-place refreshes.
More info: User experience
URL format
charm-refresh will generate the URL using this format:
https://charmhub.io/{charm_name}/docs/refresh/{charm_version}
{charm_name} will be replaced with the value of charm_name from 18. Instantiate refresh class.
{charm_version} will be replaced with the charm compatibility version of the charm code that the pre-refresh-check action is run on (i.e. the charm code version that the user will be refreshing from).
The / character in the charm compatibility version will not be URL-encoded.
https://charmhub.io/postgresql-k8s/docs/refresh/16/1.19.0
Redirect target
This URL must be redirected to user documentation that provides instructions for how to refresh from this version (e.g. 16/1.19.0) to all versions that support refreshing from that version.
| At the time this version (e.g. 16/1.19.0) is released, it will not be possible to know all of the future versions that will support refreshing from that version |
Set up redirect
Community charm developers
Contact us and we will assist you with creating the redirect