docs: reorder interface definition before fetch-libs and link PostgreSQL/library docs in tutorial
Maintainers usually reply within 3 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- postgresql
- Domain
- documentation
Research direction
Start from the tutorial page source for integrate-your-charm-with-postgresql in the docs tree. Read the two sections named in the issue, then move “Define the charm relation interface” ahead of “Fetch the required database interface charm library”. Add the PostgreSQL integration/Charmhub and data_interfaces reference links where those terms are introduced. Done when the page renders in the new order with working outbound links and no added prose.
Written by the indexing model from the issue text.
Description
Target Page
Observation
In keeping with Diátaxis tutorial principles (clear cause-and-effect sequence and outbound links to Reference/How-to docs rather than inline explanation), the first two sections of this page currently work in reverse order and omit the relevant outbound links:
-
Inverted dependency order: Fetch the required database interface charm library introduces
data_platform_libs.data_interfacesbefore Define the charm relation interface introduces the provider charm and interface:"First, find out the name of the interface that PostgreSQL offers for other charms to connect to it. According to the documentation of the PostgreSQL charm, the interface is called
postgresql_client."Because the dependency flows from
postgresql-k8s→postgresql_client→data_interfaces, defining therequiresendpoint first makes the reason for fetchingdata_interfacesself-evident without adding prose. -
Missing outbound links: Neither "the documentation of the PostgreSQL charm" nor
data_platform_libs.data_interfacesis linked when introduced (the Charmhub URL fordata_interfacesonly appears later inside a code comment under Add relation event observers).
Proposed Change
- Move Define the charm relation interface before Fetch the required database interface charm library.
- Link "the documentation of the PostgreSQL charm" to Charmed PostgreSQL – Integrate (or postgresql-k8s integrations), and link
data_platform_libs.data_interfacesto its Charmhub library page and/or the Interface libraries reference.
- Dominant language
- Python
- Stars
- 267
- Forks
- 156
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 43
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from canonical/operator
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 3 days
-
test_pull_path_non_ascii_or_trailing_whitespace fails with XPASS(strict)Possibly taken @tonyandrewmeyer claimed this today. Opentests
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
canonical/operator#2953 · 1 comment · 1 assignee ·
Maintainers usually reply within 3 days
-
rainy day small item
Difficulty 2/5 1-3 hours Newbie friendliness 71/100
Maintainers usually reply within 3 days
-
Cleaning up inconsistencies in the Manage relations how-to pagePossibly taken @tromai claimed this 2 days ago. Opendocs roadmap
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
canonical/operator#2688 · 3 comments · 1 assignee ·
Maintainers usually reply within 3 days
-
docs rainy day tests
Difficulty 3/5 1-2 days Newbie friendliness 56/100
canonical/operator#2952 · 1 reaction ·
Maintainers usually reply within 3 days
All issues in canonical/operator
Similar issues
-
needs-ac
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Ikalus1988/MisakaNet#5551 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
awslabs/visual-asset-management-system#1813 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
bug difficulty:2
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MakazhanAlpamys/Soup#3167 · 1 comment ·
Maintainers usually reply within 1 day