diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 172b723..46f001c 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -6,8 +6,9 @@ on: jobs: unit-tests: uses: canonical/operator-workflows/.github/workflows/test.yaml@main + permissions: + contents: read + pull-requests: write secrets: inherit with: - self-hosted-runner: true - self-hosted-runner-label: "edge" with-uv: true diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md index 298f5ac..77278b2 100644 --- a/docs/how-to/contribute.md +++ b/docs/how-to/contribute.md @@ -11,7 +11,7 @@ explaining your use case. - If you would like to chat with us about your use-cases or proposed implementation, you can reach us at [Canonical Matrix public channel](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) or [Discourse](https://discourse.charmhub.io/t/about-the-getting-started-category/6007). -- Familiarizing yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk) +- Familiarizing yourself with the [Charmed Operator Framework](https://canonical.com/juju/docs/ops/latest/) library will help you a lot when working on new features or bug fixes. - All enhancements require review before being merged. Code review typically examines diff --git a/docs/how-to/upgrade.md b/docs/how-to/upgrade.md index ec8a2b8..36ccc21 100644 --- a/docs/how-to/upgrade.md +++ b/docs/how-to/upgrade.md @@ -1,5 +1,5 @@ # How to upgrade -Before upgrading make sure to back up the PostgreSQL database by following the [official documentation](https://canonical-charmed-postgresql.readthedocs-hosted.com/14/how-to/back-up-and-restore/create-a-backup/) +Before upgrading make sure to back up the PostgreSQL database by following the [official documentation](https://charmhub.io/postgresql/docs) Once that's done, you can upgrade the charm by running the following command: ``` diff --git a/docs/reference/charm-architecture.md b/docs/reference/charm-architecture.md index fbd3bf5..13b5780 100644 --- a/docs/reference/charm-architecture.md +++ b/docs/reference/charm-architecture.md @@ -49,14 +49,14 @@ For more details or to participate in its development, please refer to the The `src/charm.py` is the default entry point for a charm and has the `IRCCharm` Python class which inherits from the `CharmBase`. -CharmBase is the base class from which all Charms are formed, defined by [Ops](https://juju.is/docs/sdk/ops) +CharmBase is the base class from which all Charms are formed, defined by [Ops](https://canonical.com/juju/docs/ops/latest/) (Python framework for developing charms). -See more information in [Charm](https://canonical-juju.readthedocs-hosted.com/en/3.6/user/reference/charm/). +See more information in [Charm](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/). The `__init__` method guarantees that the charm observes all events relevant to its operation and handles them. Note that the IRC Bridge is a machine charm, meaning it may differ from a Kubernetes charm in various ways. -You can learn more about this in the [Charm Taxonomy](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/charm/charm-taxonomy/#machine). +You can learn more about this in the [Charm Taxonomy](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/). diff --git a/docs/tutorial/deploy-irc-bridge.md b/docs/tutorial/deploy-irc-bridge.md index b8607b3..8bf6405 100644 --- a/docs/tutorial/deploy-irc-bridge.md +++ b/docs/tutorial/deploy-irc-bridge.md @@ -11,7 +11,7 @@ with other charms to set up a working Matrix application. * Juju 3 installed and bootstrapped to a LXD and MicroK8s controller. You can accomplish -this process by using a [Multipass](https://multipass.run/) VM as outlined in this guide: [Set up / Tear down your test environment](https://canonical-juju.readthedocs-hosted.com/en/3.6/user/howto/manage-your-deployment/manage-your-deployment-environment/#set-things-up) +this process by using a [Multipass](https://multipass.run/) VM as outlined in this guide: [Set up / Tear down your test environment](https://canonical.com/juju/docs/juju-cli/3.6/reference/) * [Synapse charm](https://charmhub.io/synapse) deployed. Refer to the [Synapse Getting Started](https://charmhub.io/synapse/docs/tutorial-getting-started) tutorial for step-by-step instructions. :warning: When using a Multipass VM, make sure to replace IP addresses with the @@ -109,7 +109,7 @@ Save the password since it will be used in further steps. ### Create an offer Since IRC Bridge is running in a different model, the integration between them -should be done via an [Offer](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/offer/#offer). +should be done via an [Offer](https://canonical.com/juju/docs/juju-cli/3.6/reference/). The following command will expose the Matrix Auth endpoint, allowing other applications to integrate with it.