Skip to content

Commit

Permalink
Add docs key and point at Discourse
Browse files Browse the repository at this point in the history
Add the 'docs' key and point it at a Discourse topic
previously populated with the charm's README contents.

When the new charm revision is released to the Charmhub,
this Discourse-based content will be displayed there. In
the absense of the this new key, the Charmhub's default
behaviour is to display the value of the charm's
'description' key.

Change-Id: Id759ee81cea83fe9b18671ce5bc19a31db319a77
  • Loading branch information
jadonn authored and sabaini committed Sep 12, 2023
1 parent c9d220a commit 8c073a6
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 30 deletions.
1 change: 1 addition & 0 deletions metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ description: |
.
This charm provides the RADOS HTTP gateway supporting S3 and Swift protocols
for object storage.
docs: https://discourse.charmhub.io/t/ceph-radosgw-docs-index/11005
tags:
- openstack
- storage
Expand Down
28 changes: 0 additions & 28 deletions osci.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
- project:
templates:
- charm-unit-jobs-py38
- charm-unit-jobs-py39
- charm-unit-jobs-py310
check:
jobs:
Expand All @@ -12,7 +11,6 @@
- jammy-zed-multisite
- jammy-antelope-multisite:
voting: false
- kinetic-zed-multisite
- lunar-antelope-multisite:
voting: false
- vault-jammy-yoga_rgw
Expand All @@ -23,8 +21,6 @@
voting: false
- vault-jammy-antelope-namespaced:
voting: false
- vault-kinetic-zed_rgw
- vault-kinetic-zed-namespaced
- vault-lunar-antelope_rgw:
voting: false
- vault-lunar-antelope-namespaced:
Expand All @@ -41,7 +37,6 @@
- osci-lint
- charm-build
- tox-py38
- tox-py39
- name: tox-py310
soft: true
vars:
Expand Down Expand Up @@ -70,13 +65,6 @@
- jammy-yoga-multisite
vars:
tox_extra_args: jammy-antelope-multisite
- job:
name: kinetic-zed-multisite
parent: func-target
dependencies:
- jammy-yoga-multisite
vars:
tox_extra_args: kinetic-zed-multisite
- job:
name: lunar-antelope-multisite
parent: func-target
Expand Down Expand Up @@ -142,22 +130,6 @@
- vault-jammy-yoga-namespaced
vars:
tox_extra_args: vault:jammy-zed-namespaced
- job:
name: vault-kinetic-zed_rgw
parent: func-target
dependencies:
- vault-jammy-yoga_rgw
- vault-jammy-yoga-namespaced
vars:
tox_extra_args: vault:kinetic-zed
- job:
name: vault-kinetic-zed-namespaced
parent: func-target
dependencies:
- vault-jammy-yoga_rgw
- vault-jammy-yoga-namespaced
vars:
tox_extra_args: vault:kinetic-zed-namespaced
- job:
name: vault-jammy-antelope_rgw
parent: func-target
Expand Down
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ six>=1.9.0
dnspython

psutil>=1.1.1,<2.0.0

# newer jsonschema needs rustc and cargo
jsonschema<4.18.0
2 changes: 0 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,7 @@ deps = -r{toxinidir}/requirements.txt
[testenv:pep8]
basepython = python3
deps = flake8==3.9.2
git+https://github.com/juju/charm-tools.git
commands = flake8 {posargs} hooks unit_tests tests actions lib files
charm-proof

[testenv:cover]
# Technique based heavily upon
Expand Down

0 comments on commit 8c073a6

Please sign in to comment.