Refactor v14 documentation for Sphinx #919

a-velasco · 2025-05-27T18:56:53Z

Issue

With the upcoming release of PG 16, documentation versioning is needed.

Solution

Introduce the Canonical Sphinx Starter Pack for compatibility with Read The Docs/Sphinx.

Documentation was stored as raw markdown files periodically downloaded from Discourse. For compatibility with RTD/Sphinx, this PR:

Adds the Sphinx starter pack - this contains all the infrastructure and tooling to build and publish a documentation set to the Canonical organization on Read The Docs.
Updates and fixes various formatting issues, such as headings, cross-references, and Discourse markdown elements
Moves image hosting from Discourse to the local repository

To simplify review as much as possible, there are no changes to the contents or structure of the documentation besides some light edits to the home page.

Checklist

I have added or updated any relevant documentation.
I have cleaned any remaining cloud resources from my accounts.

.github/workflows/automatic-doc-checks.yml

.github/workflows/markdown-style-checks.yml

.github/workflows/sphinx-python-dependency-build-checks.yml

codecov · 2025-05-27T18:57:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.76%. Comparing base (5c19764) to head (dbf6332).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #919      +/-   ##
==========================================
- Coverage   72.23%   71.76%   -0.47%     
==========================================
  Files          16       16              
  Lines        4044     4101      +57     
  Branches      609      617       +8     
==========================================
+ Hits         2921     2943      +22     
- Misses        931      964      +33     
- Partials      192      194       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ences

taurus-forever

Massive and impressive
Thank you!
LGTM to docs itself, but I have some questions to .spinx part (see inline).
there are lint errors at the end of PR "Unchanged files with check annotations". should we address them here? Otherwise they will popup the next PR again.

.github/workflows/automatic-doc-checks.yml

.github/workflows/markdown-style-checks.yml

.github/workflows/sphinx-python-dependency-build-checks.yml

README.md

docs/.sphinx/get_vale_conf.py

docs/.sphinx/metrics/source_metrics.sh

docs/.sphinx/update_sp.py

docs/explanation/architecture.md

README.md

docs/conf.py

docs/explanation/legacy-charm.md

Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com>

…rator into 14/docs

* Update index.md: add link to roles.md * Typo fix

With the move to Sphinx + RTD (canonical/postgresql-operator#919), the sync_docs.yaml workflow should not be added to charm repositories that are not already using it

* [MISC] Use latest/stable lxd (#804) * Use latest stable lxd * Test tweaks * Test tweaks * Update canonical/data-platform-workflows action to v31.0.1 (#805) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [DPE-6874] Poll all members in the cluster topology script (#810) * Poll all members in the cluster topology script * Dual branch config * Unit tests and bugfixes * Add peers when starting the observer * Retry sync up checks * [DPE-6572] Add wal_keep_size config option (#799) * Add wal_keep_size config option Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove parameter addition Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Reset durability_wal_keep_size value to PG default Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Create pull_request_template.md (#814) * Create SECURITY.md (#822) * Update README file's security section (#827) * Refactor headings for syntax best practice * Update the Security section * Sync docs from Discourse (#796) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * [MISC] Conditional checksum calculation (#812) * Bump boto * Conditional checksum calculation * [DPE-6218] Static code analysis (#828) * Create tiobe_scan.yaml * Remove push trigger * [MISC] Disable landscape subordinate test lxd (#831) * Set series for ubuntu-advantage test and disable the landscape test * Revert to LTS LXD * Update charmcraft.yaml build tools (#815) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Update snapped PostgreSQL (#832) * [DPE-6345] LDAP I: Create access groups (#823) * [DPE-6345] LDAP II: Include charm libs (#824) * [DPE-6345] LDAP III: Define config and handlers (#825) * [DPE-6345] LDAP IV: Define snap service (#838) * [DPE-6345] LDAP V: Define mapping option (#849) * [MISC] Disable network cut tests on arm (#844) * Disable network cut tests on arm * Back to LXD 5 * [DPE-6815] disable pgaudit during extensions changes (#842) * disable pgaudit during extensions changes * Bump libs * Lock file maintenance Python dependencies (main) (#816) * Lock file maintenance Python dependencies * Fix linting --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Dragomir Penev <dragomir.penev@canonical.com> * Update dependency uv to v0.6.16 (#847) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [DPE-6664] Make username mandatory in set-password (#846) * Make username mandatory * Second get password method * Default in get-password * Add conditional expose directive (#853) * Lock file maintenance Python dependencies (#854) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Mandatory scope for promote action (#856) * Update charmcraft.yaml build tools (#860) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Lock file maintenance Python dependencies (#861) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Sync docs from Discourse (#850) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * [MISC] Extend relation-user listing syntax (#868) * Move _update_member_ip call to correctly remove Raft cluster member when network is cut Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix coverage Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Sync libs (#884) * Update refresh tests to modify charm to ensure refresh off edge or stable * Fix lint warnings * Store temporary charms in /tmp for upgrade_from_stable tests * Use force-refresh-start instead of forcing refresh by updating versions * Remove runner password (#913) * [DPE-6898] User->databases pg_hba rules (#885) * Restrict each user to their allowed databases Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix unit tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix sync users on replicas Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix unit test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add default landscape user permission Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Increase sleep time in pg_hba test, fix user->database mapping for upgrade from stable and skip event trigger function code when not a superuser Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Improve users list check Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix raft reinitialisation in tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Decrease the amount of API calls by one Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Check users list directly Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Tweak test fast interval Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Improvements to avoid replica restart while syncing from primary Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix linting Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Handle same snap revision situation in upgrade tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Merge Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Improvement to avoid replica restart while syncing from primary Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Run stop-continuous-writes action only once Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Increase sleep time in Juju spaces test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Update charmcraft.yaml build tools (#871) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Remove JujuVersion warning in 14/edge (#933) * Remove JujuVersion warning * Update libs * Refactor v14 documentation for Sphinx (#919) * initial starter pack transfer * update conf.py * import processed discourse pages * fix internal references and some broken URLs * fix some style errors * organize navigation * remove h1 heading anchors * add images to repository * edit home page * update .readthedocs.yaml * remove docs/requirements.txt from .gitignore scope * fix incorrect paths * remove shell syntax from code blocks * remove juju 2 banners * fix dropdown formatting * fix and polish admonitions, collapsible, and misc formatting * remove v16 docs * remove reference to nonexistant page * Join all tutorial pages * rename how-to-guides to how-to * polish cloud deployment guides and rename leftover how-to-guide references * polish and sync how-to guides with k8s * remove discourse sync workflow * specify channel on all deploy commands * misc polishing, add version to side nav * add pg 16 admonitions * ignore docs folder in charm workflows * sync misc. pages with k8s * Minor README update with new documentation link * add new section to CLI-helpers reference * pin commit for v16 tag on markdown lint workflow for added security * Update README.md * remove sphinx python dependency check workflow * Update index.md: add link to roles.md (#928) --------- Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: Alex Lutay <1928266+taurus-forever@users.noreply.github.com> * [DPE-7511] Fix the auth username pattern (#941) * Fix auth username pattern Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix another ocurrence of the pattern Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add temp tablespace create * Temp tblspace outside of transaction * Reset role in test_pg_hba setup Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Detect when databases and their ACLs change Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix predefined catalog roles test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix unit test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add unit tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add missing autocommit Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove _hash suffix from variables names Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * [MISC] Fix timeouts in 14 to 16 merge (#959) * Handle PostgreSQLListUsersError * Try to trigger the pg_hba update on db requested * Try to hold db requested until pg_hba is up to date * Increase timeouts * Scale in parallel * Fix param passing * Increase timeout * Try to scale without ffwd * Try not to defer rel changed * Remove extra hook * Check if patroni is running before calling the health endpoint * Revert timeout * Pass the timeout param --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: Dragomir Penev <6687393+dragomirp@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andreia <andreia.velasco@canonical.com> Co-authored-by: Vladimir Izmalkov <48120135+izmalk@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Sinclert Pérez <sinclert.perez@canonical.com> Co-authored-by: Dragomir Penev <dragomir.penev@canonical.com> Co-authored-by: swetha1654 <swetha.swaminathan@canonical.com> Co-authored-by: Shayan Patel <shayan.patel@canonical.com> Co-authored-by: Alex Lutay <1928266+taurus-forever@users.noreply.github.com>

* [MISC] Use latest/stable lxd (canonical#804) * Use latest stable lxd * Test tweaks * Test tweaks * Update canonical/data-platform-workflows action to v31.0.1 (canonical#805) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [DPE-6874] Poll all members in the cluster topology script (canonical#810) * Poll all members in the cluster topology script * Dual branch config * Unit tests and bugfixes * Add peers when starting the observer * Retry sync up checks * [DPE-6572] Add wal_keep_size config option (canonical#799) * Add wal_keep_size config option Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove parameter addition Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Reset durability_wal_keep_size value to PG default Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Create pull_request_template.md (canonical#814) * Create SECURITY.md (canonical#822) * Update README file's security section (canonical#827) * Refactor headings for syntax best practice * Update the Security section * Sync docs from Discourse (canonical#796) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * [MISC] Conditional checksum calculation (canonical#812) * Bump boto * Conditional checksum calculation * [DPE-6218] Static code analysis (canonical#828) * Create tiobe_scan.yaml * Remove push trigger * [MISC] Disable landscape subordinate test lxd (canonical#831) * Set series for ubuntu-advantage test and disable the landscape test * Revert to LTS LXD * Update charmcraft.yaml build tools (canonical#815) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Update snapped PostgreSQL (canonical#832) * [DPE-6345] LDAP I: Create access groups (canonical#823) * [DPE-6345] LDAP II: Include charm libs (canonical#824) * [DPE-6345] LDAP III: Define config and handlers (canonical#825) * [DPE-6345] LDAP IV: Define snap service (canonical#838) * [DPE-6345] LDAP V: Define mapping option (canonical#849) * [MISC] Disable network cut tests on arm (canonical#844) * Disable network cut tests on arm * Back to LXD 5 * [DPE-6815] disable pgaudit during extensions changes (canonical#842) * disable pgaudit during extensions changes * Bump libs * Lock file maintenance Python dependencies (main) (canonical#816) * Lock file maintenance Python dependencies * Fix linting --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Dragomir Penev <dragomir.penev@canonical.com> * Update dependency uv to v0.6.16 (canonical#847) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [DPE-6664] Make username mandatory in set-password (canonical#846) * Make username mandatory * Second get password method * Default in get-password * Add conditional expose directive (canonical#853) * Lock file maintenance Python dependencies (canonical#854) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Mandatory scope for promote action (canonical#856) * Update charmcraft.yaml build tools (canonical#860) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Lock file maintenance Python dependencies (canonical#861) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Sync docs from Discourse (canonical#850) Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> * [MISC] Extend relation-user listing syntax (canonical#868) * Move _update_member_ip call to correctly remove Raft cluster member when network is cut Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix coverage Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Sync libs (canonical#884) * Update refresh tests to modify charm to ensure refresh off edge or stable * Fix lint warnings * Store temporary charms in /tmp for upgrade_from_stable tests * Use force-refresh-start instead of forcing refresh by updating versions * Remove runner password (canonical#913) * [DPE-6898] User->databases pg_hba rules (canonical#885) * Restrict each user to their allowed databases Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix unit tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix sync users on replicas Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix unit test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add default landscape user permission Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Increase sleep time in pg_hba test, fix user->database mapping for upgrade from stable and skip event trigger function code when not a superuser Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Improve users list check Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix raft reinitialisation in tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Decrease the amount of API calls by one Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Check users list directly Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Tweak test fast interval Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Improvements to avoid replica restart while syncing from primary Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix linting Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Handle same snap revision situation in upgrade tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Merge Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Improvement to avoid replica restart while syncing from primary Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Run stop-continuous-writes action only once Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Increase sleep time in Juju spaces test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Update charmcraft.yaml build tools (canonical#871) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * [MISC] Remove JujuVersion warning in 14/edge (canonical#933) * Remove JujuVersion warning * Update libs * Refactor v14 documentation for Sphinx (canonical#919) * initial starter pack transfer * update conf.py * import processed discourse pages * fix internal references and some broken URLs * fix some style errors * organize navigation * remove h1 heading anchors * add images to repository * edit home page * update .readthedocs.yaml * remove docs/requirements.txt from .gitignore scope * fix incorrect paths * remove shell syntax from code blocks * remove juju 2 banners * fix dropdown formatting * fix and polish admonitions, collapsible, and misc formatting * remove v16 docs * remove reference to nonexistant page * Join all tutorial pages * rename how-to-guides to how-to * polish cloud deployment guides and rename leftover how-to-guide references * polish and sync how-to guides with k8s * remove discourse sync workflow * specify channel on all deploy commands * misc polishing, add version to side nav * add pg 16 admonitions * ignore docs folder in charm workflows * sync misc. pages with k8s * Minor README update with new documentation link * add new section to CLI-helpers reference * pin commit for v16 tag on markdown lint workflow for added security * Update README.md * remove sphinx python dependency check workflow * Update index.md: add link to roles.md (canonical#928) --------- Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: Alex Lutay <1928266+taurus-forever@users.noreply.github.com> * [DPE-7511] Fix the auth username pattern (canonical#941) * Fix auth username pattern Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix another ocurrence of the pattern Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add temp tablespace create * Temp tblspace outside of transaction * Reset role in test_pg_hba setup Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Detect when databases and their ACLs change Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix predefined catalog roles test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Fix unit test Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add unit tests Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Add missing autocommit Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * Remove _hash suffix from variables names Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> * [MISC] Fix timeouts in 14 to 16 merge (canonical#959) * Handle PostgreSQLListUsersError * Try to trigger the pg_hba update on db requested * Try to hold db requested until pg_hba is up to date * Increase timeouts * Scale in parallel * Fix param passing * Increase timeout * Try to scale without ffwd * Try not to defer rel changed * Remove extra hook * Check if patroni is running before calling the health endpoint * Revert timeout * Pass the timeout param --------- Signed-off-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Co-authored-by: Dragomir Penev <6687393+dragomirp@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andreia <andreia.velasco@canonical.com> Co-authored-by: Vladimir Izmalkov <48120135+izmalk@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Sinclert Pérez <sinclert.perez@canonical.com> Co-authored-by: Dragomir Penev <dragomir.penev@canonical.com> Co-authored-by: swetha1654 <swetha.swaminathan@canonical.com> Co-authored-by: Shayan Patel <shayan.patel@canonical.com> Co-authored-by: Alex Lutay <1928266+taurus-forever@users.noreply.github.com>

a-velasco added 9 commits May 26, 2025 11:33

initial starter pack transfer

7ea2289

update conf.py

8c49d2b

import processed discourse pages

d9022b0

fix internal references and some broken URLs

0cd1f01

fix some style errors

507b4eb

organize navigation and misc formatting fixes

c632484

remove h1 heading anchors

2177626

add images to repository

b7a51d7

edit home page and misc small fixes

377b3a9

a-velasco changed the title ~~14/docs~~ Refactor documentation for Sphinx May 27, 2025

github-actions bot added the Libraries: Out of sync label May 27, 2025

github-advanced-security bot found potential problems May 27, 2025

View reviewed changes

.github/workflows/automatic-doc-checks.yml Dismissed Show dismissed Hide dismissed

.github/workflows/markdown-style-checks.yml Dismissed Show dismissed Hide dismissed

.github/workflows/sphinx-python-dependency-build-checks.yml Fixed Show fixed Hide fixed

a-velasco added the documentation Improvements or additions to documentation label May 27, 2025

a-velasco added 16 commits May 28, 2025 15:20

update .readthedocs.yaml

745a35a

remove docs/requirements.txt from .gitignore scope

8e309a3

fix incorrect paths

52fb18e

remove shell syntax from code blocks

d47fc1d

remove juju 2 banners

448d681

fix dropdown formatting

6a40c3a

fix and polish admonitions, collapsible, and misc formatting

f0176a6

remove v16 docs

1d8f79b

remove reference to nonexistant page

3db483f

Join all tutorial pages

49eff9b

rename how-to-guides to how-to

1781e94

polish cloud deployment guides and rename leftover how-to-guide refer…

31b172a

…ences

polish and sync how-to guides with k8s

18fc5be

misc polishing and sync with k8s

e7d5722

fix reference issues

3a24158

remove discourse sync workflow

d1796bb

carlcsaposs-canonical mentioned this pull request Jun 3, 2025

compatible: Deprecate sync_docs.yaml canonical/data-platform-workflows#297

Merged

a-velasco added 2 commits June 3, 2025 19:19

sync misc. pages with k8s

a6ce7ff

Minor README update with new documentation link

6f85346

a-velasco mentioned this pull request Jun 3, 2025

Refactor v14 documentation for Sphinx canonical/postgresql-k8s-operator#981

Merged

2 tasks

add new section to CLI-helpers reference

43cc92b

taurus-forever reviewed Jun 4, 2025

View reviewed changes

a-velasco added 2 commits June 4, 2025 18:57

fix K8s typo

41dddcf

pin commit for v16 tag on markdown lint workflow for added security

b5e6976

marceloneppel reviewed Jun 4, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

docs/conf.py Show resolved Hide resolved

docs/explanation/legacy-charm.md Outdated Show resolved Hide resolved

a-velasco and others added 4 commits June 5, 2025 10:30

Update README.md

58783f2

Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com>

remove text relevant only for K8s

4186ef3

Merge branch '14/docs' of https://github.com/canonical/postgresql-ope…

3713907

…rator into 14/docs

remove sphinx python dependency check workflow

6db4615

a-velasco requested review from taurus-forever and marceloneppel June 5, 2025 12:41

marceloneppel approved these changes Jun 5, 2025

View reviewed changes

a-velasco changed the title ~~Refactor documentation for Sphinx~~ Refactor v14 documentation for Sphinx Jun 5, 2025

a-velasco mentioned this pull request Jun 5, 2025

Refactor v16 documentation for Sphinx #936

Merged

2 tasks

Update index.md: add link to roles.md (#928)

2ece988

* Update index.md: add link to roles.md * Typo fix

github-actions bot added Libraries: OK and removed Libraries: Out of sync labels Jun 5, 2025

This was referenced Jun 5, 2025

Sync docs from Discourse canonical/postgresql-k8s-operator#979

Closed

Sync docs from Discourse #870

Closed

update home page

dbf6332

taurus-forever approved these changes Jun 6, 2025

View reviewed changes

a-velasco merged commit 3bd748a into main Jun 6, 2025
92 of 101 checks passed

a-velasco deleted the 14/docs branch June 6, 2025 10:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor v14 documentation for Sphinx #919

Refactor v14 documentation for Sphinx #919

Uh oh!

a-velasco commented May 27, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented May 27, 2025 •

edited

Loading

Uh oh!

taurus-forever left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Refactor v14 documentation for Sphinx #919

Refactor v14 documentation for Sphinx #919

Uh oh!

Conversation

a-velasco commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue

Solution

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

taurus-forever left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

a-velasco commented May 27, 2025 •

edited

Loading

codecov bot commented May 27, 2025 •

edited

Loading