Skip to content

docs: refactor getting started tutorial (ISD-7317) - #147

Merged
f-atwi merged 3 commits into
mainfrom
docs/ISD-7317-refactor-tutorial
Nov 20, 2026
Merged

f-atwi merged 3 commits into
mainfrom
docs/ISD-7317-refactor-tutorial

Conversation

@f-atwi

@f-atwi f-atwi commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Applicable spec: ISD-7317

Overview

Refactors the getting started tutorial following the platform engineering charm template: updated requirements (Concierge, Canonical Kubernetes, MicroCeph for S3), Gateway API Integrator with Ingress Configurator for ingress, an explanation of what each charm is for, a self-signed certificate note, and next steps.

Rationale

The tutorial had outdated requirements and used nginx-ingress-integrator. It didn't explain why each charm is deployed. Ingress Configurator is needed because the ingress relation of Gateway API Integrator serves apps under a path prefix, which Penpot doesn't support.

Tested on a Multipass VM with Canonical Kubernetes. The final ordering of steps wasn't re-run from scratch, and login was checked with curl only, not in a browser.

Juju Events Changes

None.

Module Changes

None.

Library Changes

None.

Checklist

Unchecked items are not applicable: docs only, no code changes.

@f-atwi
f-atwi requested a review from a team as a code owner November 19, 2026 19:39
@f-atwi f-atwi added the documentation Improvements or additions to documentation label Nov 19, 2026
@f-atwi f-atwi self-assigned this Nov 19, 2026
@f-atwi
f-atwi requested a review from erinecon November 19, 2026 19:42

@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.

Thank you for updating the tutorial 🚀 some non-blocking nits and comments for your consideration

Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
Comment thread docs/tutorial/getting-started.md Resolved
@f-atwi
f-atwi merged commit 480c5ca into main Nov 20, 2026
17 checks passed
@f-atwi
f-atwi deleted the docs/ISD-7317-refactor-tutorial branch November 20, 2026 08:29
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 Libraries: Out of sync

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants