Skip to content

Conversation

@a-velasco
Copy link
Contributor

Port of canonical/postgresql-operator#1260


This PR updates Diataxis pages to comply with Canonical's Documentation standards for landing pages:

  • Standardizes structure and formatting across all index pages (toctrees instead of links, categories)
  • Addes or updates sentences with a concise summary of what to expect from each section or group of pages

Additional changes:

  • Changed some links to safer Sphinx syntax ({ref} instead of []())
  • Moved tutorial/index.md to tutorial.md, since it is a single page

Checklist

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

@a-velasco a-velasco added documentation Improvements or additions to documentation not bug or enhancement PR is not 'bug' or 'enhancement'. For release notes labels Oct 28, 2025
[Multi-AZ]: /how-to/deploy/multi-az
[Terraform]: /how-to/deploy/terraform
[Air-gapped]: /how-to/deploy/air-gapped
In-place upgrades to higher revisions of Charmed PostgreSQL 16:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "higher" is not necessarily accurate; higher revision can be semantically older (and using "higher" language, imo, causes users to think of revisions as semantically sequential)

@a-velasco a-velasco merged commit 0adfc1f into 16/edge Oct 29, 2025
5 checks passed
@a-velasco a-velasco deleted the update-landing-pages-16 branch October 29, 2025 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation not bug or enhancement PR is not 'bug' or 'enhancement'. For release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants