Skip to content

Add landing pages to OpenCTI documents#149

Open
weiiwang01 wants to merge 2 commits intomainfrom
landing-page
Open

Add landing pages to OpenCTI documents#149
weiiwang01 wants to merge 2 commits intomainfrom
landing-page

Conversation

@weiiwang01
Copy link
Copy Markdown
Collaborator

Applicable spec:

Overview

Add landing pages to OpenCTI documents

Rationale

Juju Events Changes

Module Changes

Add landing pages to OpenCTI documents.

Library Changes

Checklist

@weiiwang01 weiiwang01 requested a review from erinecon April 23, 2026 16:46
@weiiwang01 weiiwang01 requested a review from a team as a code owner April 23, 2026 16:46
@weiiwang01 weiiwang01 added the documentation Improvements or additions to documentation label Apr 23, 2026
Copy link
Copy Markdown
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.

Thank you so much for creating landing pages 🎉 some initial comments from me

Comment thread docs/how-to/index.md
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.

I don't like the fact that there's an orphan page under a section, but since I'm interested in writing more documentation about using Terraform modules, I think we should leave this page alone and add onto the developer section in the near future :)

Comment thread docs/how-to/index.md
## Guide for developers

Learn the guidelines and best practices before contributing to the
backup charm project.
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.

Suggested change
backup charm project.
OpenCTI charms project.

Comment thread docs/reference/index.md
Comment on lines +16 to +24
* [Integrations](integrations.md)
* [Observability](observability.md)

## Charm architecture and designs

Components and dependencies within the OpenCTI charms, along with the
architecture decisions made during charm creation.

* [Charm architecture](charm-architecture.md)
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.

To avoid having an orphan file under this section, I recommend we regroup the integrations.md page:

Suggested change
* [Integrations](integrations.md)
* [Observability](observability.md)
## Charm architecture and designs
Components and dependencies within the OpenCTI charms, along with the
architecture decisions made during charm creation.
* [Charm architecture](charm-architecture.md)
* [Observability](observability.md)
## Charm architecture and designs
Components and dependencies within the OpenCTI charms,
architecture decisions made during charm creation, and how
the charms connect to the broader Juju ecosystem.
* [Charm architecture](charm-architecture.md)
* [Integrations](integrations.md)

Comment thread docs/reference/index.md
Comment on lines +10 to +12
actions. Understanding the overall charm architecture provides the
structural context needed to see how those settings and actions interact
at runtime.
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.

Since you've grouped the architecture page into the other section, I think we should remove this sentence about charm architecture from under the "Charm configuration and operations" section. You could move it under the charm architecture section -- I trust your judgement :)

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.

2 participants