Skip to content

docs: add landing pages#72

Merged
florentianayuwono merged 5 commits intomainfrom
docs/landing-page-ISD-5220
Mar 6, 2026
Merged

docs: add landing pages#72
florentianayuwono merged 5 commits intomainfrom
docs/landing-page-ISD-5220

Conversation

@florentianayuwono
Copy link
Collaborator

@florentianayuwono florentianayuwono commented Mar 5, 2026

Applicable spec:

Overview

Add landing pages for how-to and reference section.

Rationale

To aid user in navigating the documentations.

Juju Events Changes

Module Changes

Library Changes

Checklist

@florentianayuwono florentianayuwono self-assigned this Mar 5, 2026
@florentianayuwono florentianayuwono requested a review from a team as a code owner March 5, 2026 04:58
@florentianayuwono florentianayuwono added the documentation Improvements or additions to documentation label Mar 5, 2026
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

license-eye has checked 77 files.

Valid Invalid Ignored Fixed
27 2 48 0
Click to see the invalid file list
  • docs/how-to/index.rst
  • docs/reference/index.rst
Use this command to fix any missing license headers
```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

florentianayuwono and others added 2 commits March 5, 2026 12:00
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds landing page index files (index.rst) for the how-to and reference documentation sections of the aproxy charm. These landing pages provide structured navigation with categorized toctree directives, grouping existing documentation pages under themed subsections (e.g., "Basic operations", "Charm usage", "Architecture and deployments").

Changes:

  • Added docs/how-to/index.rst with toctree sections for basic operations, update/refresh, and development guides.
  • Added docs/reference/index.rst with toctree sections for charm usage and architecture/deployment references.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
docs/how-to/index.rst New landing page for how-to guides, organizing configure, backup/restore, upgrade, and contribute pages into categorized sections.
docs/reference/index.rst New landing page for reference documentation, organizing actions, configurations, integrations, and charm architecture pages into categorized sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

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

Thanks so much!!

Note that you might want to add the landing pages into docs/index.md under the Contents section

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@florentianayuwono florentianayuwono merged commit d70be3d into main Mar 6, 2026
40 of 42 checks passed
@florentianayuwono florentianayuwono deleted the docs/landing-page-ISD-5220 branch March 6, 2026 06:10
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: OK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants