Merge branch 'main' into sync14to16

Author: dragomirp

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

@@ -0,0 +1,24 @@
+#
+name: Automatic doc checks
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    paths:
+      - 'docs/**'   # Only run on changes to the docs directory
+
+  workflow_dispatch:
+    # Manual trigger
+
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  documentation-checks:
+    uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
+    with:
+      working-directory: "docs"
+      fetch-depth: 0

.github/workflows/ci.yaml

@@ -14,7 +14,7 @@ on:
       - 'LICENSE'
       - '**.md'
       - .github/renovate.json5
-      - '.github/workflows/sync_docs.yaml'
+      - 'docs/**'
   schedule:
     - cron: '53 0 * * *'  # Daily at 00:53 UTC
   # Triggered on push to branch "main" by .github/workflows/release.yaml

.github/workflows/lib-check.yaml

@@ -14,6 +14,7 @@ on:
       - 'LICENSE'
       - '**.md'
       - 'renovate.json'
+      - 'docs/**'
 
 jobs:
   lib-check:

.github/workflows/sync_docs.yaml

@@ -6,7 +6,7 @@ build/
 __pycache__/
 *.py[cod]
 coverage.xml
-requirements.txt
+/requirements.txt
 requirements-last-build.txt
 .last_refresh_unit_status.json
 

.gitignore

@@ -4,19 +4,14 @@
 [![Tests](https://github.com/canonical/postgresql-operator/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/canonical/postgresql-operator/actions/workflows/ci.yaml?query=branch%3Amain)
 [![codecov](https://codecov.io/gh/canonical/postgresql-operator/graph/badge.svg?token=4V2mu7aWmu)](https://codecov.io/gh/canonical/postgresql-operator)
 
-## Description
 
-This repository contains a [Juju Charm](https://charmhub.io/postgresql) for deploying [PostgreSQL](https://www.postgresql.org/about/) on virtual machines ([LXD](https://ubuntu.com/lxd)).
-To deploy on Kubernetes, please use [Charmed PostgreSQL K8s Operator](https://charmhub.io/postgresql-k8s).
+This repository contains a charmed operator for deploying [PostgreSQL](https://www.postgresql.org/about/) on virtual machines via the [Juju orchestration engine](https://juju.is/).
 
-This operator provides a PostgreSQL database with replication enabled: one primary instance and one (or more) hot standby replicas. The Operator in this repository is a Python script which wraps PostgreSQL versions distributed by Ubuntu Jammy series and adding [Patroni](https://github.com/zalando/patroni) on top of it, providing lifecycle management and handling events (install, configure, integrate, remove, etc).
+To learn more about how to deploy and operate Charmed PostgreSQL, see the [official documentation](https://canonical-charmed-postgresql.readthedocs-hosted.com/).
 
-## README contents
+## Overview
 
-* [Basic usage](#basic-usage): Deploy and scale Charmerd PostgreSQL
-* [Integrations](#integrations-relations): Supported interfaces for integrations
-* [Contributing](#contributing)
-* [Licensing and trademark](#licensing-and-trademark)
+This operator provides a PostgreSQL database with replication enabled: one primary instance and one (or more) hot standby replicas. The Operator in this repository is a Python script which wraps PostgreSQL versions distributed by Ubuntu Jammy series and adding [Patroni](https://github.com/zalando/patroni) on top of it, providing lifecycle management and handling events (install, configure, integrate, remove, etc).
 
 ## Basic usage
 

README.md

@@ -10,7 +10,6 @@ This section contains pages with more detailed explanations that provide additio
 
 ## Operational concepts
 * [Connection pooling]
-* [Units]
 * [Users]
 * [Logs]
 
@@ -23,7 +22,6 @@ This section contains pages with more detailed explanations that provide additio
 
 [Architecture]: /t/11857
 [Interfaces and endpoints]: /t/10251
-[Units]: /t/17525
 [Users]: /t/10798
 [Logs]: /t/12099
 [Juju]: /t/11985

docs/explanation.md

@@ -1,4 +1,4 @@
-# Users
+# Charm Users explanations
 
 There are three types of users in PostgreSQL:
 * Internal users (used by charm operator)

docs/explanation/e-units.md

@@ -17,10 +17,6 @@ Specific deployment scenarios and architectures:
 * [Terraform]
 * [Air-gapped]
 * [TLS VIP access]
-* [Juju spaces]
-* [Air-gapped]
-* [Terraform]
-* [Juju storage]
 
 ## Usage and maintenance
 
@@ -29,7 +25,6 @@ Specific deployment scenarios and architectures:
 * [Scale replicas]
 * [Enable TLS]
 * [Enable plugins/extensions]
-* [Switchover/failover]
 
 ## Backup and restore
 * [Configure S3 AWS]
@@ -41,10 +36,9 @@ Specific deployment scenarios and architectures:
 
 ## Monitoring (COS)
 
-* [Enable monitoring] with Grafana
-* [Enable alert rules] with Prometheus
-* [Enable tracing] with Tempo
-* [Enable profiling] with Parca
+* [Enable monitoring]
+* [Enable alert rules]
+* [Enable tracing]
 
 ## Minor upgrades
 * [Perform a minor upgrade]
@@ -75,17 +69,13 @@ This section is for charm developers looking to support PostgreSQL integrations
 [GCE]: /t/15722
 [Azure]: /t/15733
 [Multi-AZ]: /t/15749
-[Juju spaces]: /t/17416
 [Terraform]: /t/14916
 [Air-gapped]: /t/15746
 [TLS VIP access]: /t/16576
-[Juju storage]: /t/17529
-
 [Integrate with another application]: /t/9687
 [External access]: /t/15802
 [Scale replicas]: /t/9689
 [Enable TLS]: /t/9685
-[Switchover/failover]: /t/17523
 
 [Configure S3 AWS]: /t/9681
 [Configure S3 RadosGW]: /t/10313
@@ -97,8 +87,7 @@ This section is for charm developers looking to support PostgreSQL integrations
 [Enable monitoring]: /t/10600
 [Enable alert rules]: /t/13084
 [Enable tracing]: /t/14521
-[Enable profiling]: /t/17172
-
+ 
 [Perform a minor upgrade]: /t/12089
 [Perform a minor rollback]: /t/12090