From a08c978a6c4c8823004814238dcdb1540c161953 Mon Sep 17 00:00:00 2001 From: swetha1654 Date: Wed, 18 Feb 2026 19:04:31 +0530 Subject: [PATCH 1/2] Add upgrade documentation --- charm/docs/how-to/upgrade.md | 17 +++++++++++++++++ .../docs/{ => reference}/charm-architecture.md | 0 2 files changed, 17 insertions(+) create mode 100644 charm/docs/how-to/upgrade.md rename charm/docs/{ => reference}/charm-architecture.md (100%) diff --git a/charm/docs/how-to/upgrade.md b/charm/docs/how-to/upgrade.md new file mode 100644 index 0000000..7bde276 --- /dev/null +++ b/charm/docs/how-to/upgrade.md @@ -0,0 +1,17 @@ +# Upgrade + +Before updating the charm, we recommend you to back up the database using the MongoDB charm’s `create-backup` action. + +```bash +juju run mongodb-k8s/leader create-backup +``` + +Additional information can be found about backing up in the MongoDB charm's [documentation](https://canonical-charmed-mongodb.readthedocs-hosted.com/6/how-to/back-up-and-restore/create-a-backup/). + +Then you can upgrade the `github-runner-webhook-router` charm: + +```bash +juju refresh github-runner-webhook-router +``` + +Verify if the charm is active and idle by running the `juju status --wait 1s` command. diff --git a/charm/docs/charm-architecture.md b/charm/docs/reference/charm-architecture.md similarity index 100% rename from charm/docs/charm-architecture.md rename to charm/docs/reference/charm-architecture.md From 2942f48a640d0c29c1477b2c6a44b80fe05cf9f0 Mon Sep 17 00:00:00 2001 From: swetha1654 Date: Wed, 18 Feb 2026 19:33:48 +0530 Subject: [PATCH 2/2] update changelog --- .github/pull_request_template.yaml | 1 - CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 10 ---------- charm/docs/index.md | 10 +++++++++- generate-src-docs.sh | 6 ------ 5 files changed, 13 insertions(+), 18 deletions(-) delete mode 100644 generate-src-docs.sh diff --git a/.github/pull_request_template.yaml b/.github/pull_request_template.yaml index 4316c07..94bb929 100644 --- a/.github/pull_request_template.yaml +++ b/.github/pull_request_template.yaml @@ -25,7 +25,6 @@ Applicable spec: - [ ] The [charm style guide](https://juju.is/docs/sdk/styleguide) was applied - [ ] The [contributing guide](https://github.com/canonical/is-charms-contributing-guide) was applied - [ ] The changes are compliant with [ISD054 - Managing Charm Complexity](https://discourse.charmhub.io/t/specification-isd014-managing-charm-complexity/11619) -- [ ] The documentation is generated using `src-docs` - [ ] The documentation for charmhub is updated - [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`) - [ ] The `CHANGELOG.md` is updated with user-relevant changes. diff --git a/CHANGELOG.md b/CHANGELOG.md index acf057c..357a7bd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Place here any unreleased changes that are subject to release in coming versions :). +## 2026-02-18 + +- Added `How to upgrade` documentation. + ## 2025-09-03 - Added changelog for tracking user-relevant changes. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b38d38..406bb8f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,16 +16,6 @@ in the root directory. The charm directory has been built using the [`paas-charm`](https://canonical-12-factor-app-support.readthedocs-hosted.com/latest/) approach and then modified to support the specific actions of this charm. - -## Generating src docs for every commit - -Run the following command: - -```bash -echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit -chmod +x .git/hooks/pre-commit -``` - ## Testing This project uses `tox` for managing test environments. There are some pre-configured environments diff --git a/charm/docs/index.md b/charm/docs/index.md index 6371d90..e0808fb 100644 --- a/charm/docs/index.md +++ b/charm/docs/index.md @@ -24,7 +24,8 @@ to provide application and Flask related metrics via Grafana dashboards. | | | |--|--| -|--| [Explanation](charm-architecture.md)
Concepts - discussion and clarification of key topics | +|--| [How-to guides](how-to/upgrade.md)
Step-by-step guides covering key operations and common tasks | +| [Reference](reference/charm-architecture.md)
Technical information - specifications, APIs, architecture |--| ## Contributing to this documentation @@ -55,3 +56,10 @@ projects, contributions, suggestions, fixes, and constructive feedback. Thinking about using the Github Runner Webhook Router Operator for your next project? [Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)! + +# Contents + +1. [How To](how-to/) + 1. [Upgrade](how-to/upgrade.md) +2. [Reference](reference/) + 1. [Charm architecture](reference/charm-architecture.md) diff --git a/generate-src-docs.sh b/generate-src-docs.sh deleted file mode 100644 index bd68dac..0000000 --- a/generate-src-docs.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/bin/env bash - -# Copyright 2026 Canonical Ltd. -# See LICENSE file for licensing details. - -lazydocs --no-watermark --output-path src-docs webhook_router/*