Skip to content

docs: Add Relation endpoints reference page (ISD-6396) - #33

Merged
danielvnguyen merged 4 commits into
mainfrom
docs/create-integration-references-page-isd-6396
Sep 9, 2026
Merged

docs: Add Relation endpoints reference page (ISD-6396)#33
danielvnguyen merged 4 commits into
mainfrom
docs/create-integration-references-page-isd-6396

Conversation

@danielvnguyen

Copy link
Copy Markdown
Collaborator

What this PR does

Adds a Relation endpoints page (docs/reference/relation-endpoints.md) documenting all of the Juju integrations that bingo supports.

Covers all seven endpoints from charmcraft.yaml:
•  grafana-dashboard (grafana_dashboard) → grafana-k8s
•  ingress (ingress) → traefik-k8s or ingress-configurator
•  logging (loki_push_api) → loki-k8s
•  metrics-endpoint (prometheus_scrape) → prometheus-k8s
•  oauth (oauth) → hydra
•  postgresql (postgresql_client) → postgresql-k8s
•  tracing (tracing) → tempo-coordinator-k8s

Also adds a missing oauth row to the integrations table in README.md.

Follows the platform-engineering-charm-template template and Discourse / Wordpress as examples.

Resolves https://warthogs.atlassian.net/browse/ISD-6396

@danielvnguyen danielvnguyen self-assigned this Sep 8, 2026
@danielvnguyen
danielvnguyen requested a review from a team as a code owner September 8, 2026 22:05
@danielvnguyen danielvnguyen added the documentation Improvements or additions to documentation label Sep 8, 2026
@danielvnguyen
danielvnguyen requested review from cardenasse, erinecon and srbouffard and removed request for a team September 8, 2026 22:05

@erinecon erinecon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for putting together the relations reference page 🚀 as a top-level note for the two suggestions I left: My understanding is that the standard guidance (from the Juju team) is to use "relation" as the noun and "integrate" as the verb.

Comment thread docs/reference/relation-endpoints.md Outdated
Comment thread docs/reference/relation-endpoints.md Outdated
danielvnguyen and others added 2 commits September 9, 2026 08:28
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@danielvnguyen
danielvnguyen enabled auto-merge (squash) September 9, 2026 15:30
@danielvnguyen
danielvnguyen merged commit 5b9f5b0 into main Sep 9, 2026
18 checks passed
@danielvnguyen
danielvnguyen deleted the docs/create-integration-references-page-isd-6396 branch September 9, 2026 16:01
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants