openstack
/
charm-guide
Code Issues Proposed changes

Trivial link changes in charm README template 

We shouldn't use links that will become outdated in
future releases of the guide.

Change-Id: I9f1e7bfd53a1b3c3c4b58b74d7c784cbe15768ac
This commit is contained in:
Peter Matulis 2022-09-15 10:08:22 -04:00
parent c570f4cc03
commit 49ee97958f
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/community/software-contrib/charm-readme-template.rst
View File

@ -26,11 +26,11 @@ and then linked to (i.e. "For more information see..."). :doc:`Ask
documentation.
When referencing another charm in a general way, link to the charm's
`Charmhub`_ entry for the most recent stable channel (e.g.
https://charmhub.io/keystone?channel=yoga/stable). When referring specifically
to information in another charm's README, link directly to the file, or to a
header in the file, by way of the charm's repository on `opendev.org`_ (e.g.
https://opendev.org/openstack/charm-keystone/src/branch/stable/yoga/README.md).
`Charmhub`_ entry (e.g. https://charmhub.io/keystone). When referring
specifically to information in another charm's README, link directly to the
file, or to a header in the file, by way of the charm's master branch on
`opendev.org`_ (e.g.
https://opendev.org/openstack/charm-keystone/src/branch/master/README.md).
Structure
---------