Skip to content

docs: populate charm documentation#6

Merged
florentianayuwono merged 30 commits into
mainfrom
doc/write-charm-documentation-ISD-4194
Oct 10, 2025
Merged

docs: populate charm documentation#6
florentianayuwono merged 30 commits into
mainfrom
doc/write-charm-documentation-ISD-4194

Conversation

@florentianayuwono

@florentianayuwono florentianayuwono commented Sep 17, 2025

Copy link
Copy Markdown
Collaborator

Applicable spec: ISD249 - Aproxy Subordinate Charm

Note to reviewer: please only consider docs changes, other changes will be reviewed in PR #4

Overview

Add relevant documentations required for releasing charm

Rationale

Part of Aproxy Charm release

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

No need for docs changes

@florentianayuwono florentianayuwono self-assigned this Sep 17, 2025
@florentianayuwono florentianayuwono added the documentation Improvements or additions to documentation label Sep 17, 2025

@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 so much for adding so much documentation in this PR! I've only gone through a couple of the pages so far -- here's a first round of comments from me. Let me know if you have any questions!

Comment thread CONTRIBUTING.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/explanation/security.md Outdated

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

Here are some suggestions on the second half of the documents (plus some suggestions to fix some of the Vale errors)

Comment thread docs/explanation/security.md
Comment thread docs/how-to/back-up-restore.md Outdated
Comment thread docs/how-to/contribute.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/reference/integrations.md Outdated
Comment thread docs/reference/integrations.md
florentianayuwono and others added 4 commits September 19, 2025 21:33
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Co-authored-by: Erin Conley <erin.conley@canonical.com>

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

The documentation is looking great! Another round of comments from me

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/explanation/charm-architecture.md
Comment thread docs/explanation/charm-architecture.md
Comment thread docs/explanation/charm-architecture.md
Comment thread docs/explanation/charm-architecture.md Outdated
Comment thread docs/index.md
florentianayuwono and others added 2 commits September 23, 2025 10:04
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Comment thread README.md Outdated
Co-authored-by: Erin Conley <erin.conley@canonical.com>

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

The documentation looks great! Non-blocking nitpicks only :D

Unless you're planning to add new documentation pages into this PR, I'm ready to approve. Let me know what the next steps are for this PR!

Comment thread docs/explanation/charm-architecture.md Outdated
Comment thread docs/explanation/charm-architecture.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/explanation/security.md Outdated
Comment thread docs/how-to/back-up-restore.md Outdated
florentianayuwono and others added 2 commits September 25, 2025 00:03
Co-authored-by: Erin Conley <erin.conley@canonical.com>

@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 adding a new how-to guide -- it's extremely useful information to document :D

Comment thread docs/how-to/configure.md
Comment thread docs/how-to/configure.md Outdated
Comment thread docs/how-to/configure.md Outdated
Comment thread docs/how-to/configure.md Outdated
Comment thread docs/how-to/configure.md Outdated
Comment thread docs/how-to/configure.md Outdated
florentianayuwono and others added 2 commits October 8, 2025 20:37
Co-authored-by: Erin Conley <erin.conley@canonical.com>

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

Comment thread docs/how-to/configure.md Outdated
florentianayuwono and others added 2 commits October 10, 2025 13:47
Co-authored-by: Weii Wang <weii.wang@canonical.com>
@florentianayuwono florentianayuwono merged commit 447b85c into main Oct 10, 2025
17 checks passed
@florentianayuwono florentianayuwono deleted the doc/write-charm-documentation-ISD-4194 branch October 10, 2025 07:13
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.

3 participants