-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add landing pages #72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,4 +26,5 @@ header: | |
| - 'zap_rules.tsv' | ||
| - '**/*.md.j2' | ||
| - 'uv.lock' | ||
| - 'docs/**' | ||
| comment: on-failure | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| .. meta:: | ||
| :description: How-to guides for operating the aproxy charm, including basic operations, upgrades, and development. | ||
|
|
||
| .. _how_to_index: | ||
|
|
||
| How-to guides | ||
| ============= | ||
|
|
||
| The following guides cover key processes and common tasks for managing and | ||
| using the aproxy charm. | ||
|
|
||
| .. vale Canonical.013-Spell-out-numbers-below-10 = NO | ||
| .. vale Canonical.500-Repeated-words = NO | ||
|
|
||
| Basic operations | ||
| ---------------- | ||
|
|
||
| Once you've finished setting up the charm, now you can perform a number | ||
| of actions with your deployment. These guides provide instructions on | ||
| basic operations you can complete with the charm. | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
|
florentianayuwono marked this conversation as resolved.
|
||
| :maxdepth: 1 | ||
|
|
||
| Configure <configure> | ||
| Integrate with COS <integrate-with-cos> | ||
|
|
||
| Update and refresh | ||
| ------------------ | ||
|
|
||
| The following guides provide instructions on upgrading your deployment, | ||
| including backup and restore processes. | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
| :maxdepth: 1 | ||
|
|
||
| Back up and restore <back-up-restore> | ||
| Upgrade <upgrade> | ||
|
|
||
| Development | ||
| ----------- | ||
|
|
||
| These guides can help you with contributing to the project. | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
| :maxdepth: 1 | ||
|
|
||
| Contribute <contribute> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| .. meta:: | ||
|
florentianayuwono marked this conversation as resolved.
|
||
| :description: Technical reference documentation for the aproxy charm, including actions, configurations, and architecture. | ||
|
|
||
| .. _reference_index: | ||
|
|
||
| Reference | ||
| ========= | ||
|
|
||
| This section contains technical details and information about the aproxy charm. | ||
|
|
||
| Charm usage | ||
| ----------- | ||
|
|
||
| The following pages provide more information about the charm's features, | ||
| including actions, configurations, and integrations. | ||
|
|
||
| .. vale Canonical.013-Spell-out-numbers-below-10 = NO | ||
| .. vale Canonical.500-Repeated-words = NO | ||
| .. vale Canonical.004-Canonical-product-names = NO | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
| :maxdepth: 1 | ||
|
|
||
|
florentianayuwono marked this conversation as resolved.
|
||
| Actions <actions> | ||
| Configurations <configurations> | ||
| Integrations <integrations> | ||
| Metrics <metrics> | ||
|
|
||
| .. vale Canonical.004-Canonical-product-names = YES | ||
|
|
||
| Architecture and deployments | ||
| ---------------------------- | ||
|
|
||
| The following pages provide more details about the charm architecture and | ||
| a high-level deployment with any required dependencies. | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
| :maxdepth: 1 | ||
|
|
||
| Charm architecture <charm-architecture> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.