Skip to content
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

[upload-charm-docs] Migrate charm docs #61

Merged
merged 2 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/explanation/charm-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ juju config smtp_login=user1
```python
self.framework.observe(self.on.config_changed, self._on_config_changed)
```
4. The method `_on_config_changed`, for its turn, will take the necessary actions such as waiting for all the relations to be ready and then configuring the containers.
4. The method `_on_config_changed`, for its turn, will take the necessary actions such as waiting for all the relations to be ready and then configuring the containers.
2 changes: 1 addition & 1 deletion docs/how-to/cache-content-with-openstack-swift.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to cache content with OpenStack/Swift storage
# Cache content with OpenStack/Swift storage

Sometimes it is desirable to cache swift storage objects inside the charm for faster processing and reducing the number of requests to the [swift](https://docs.openstack.org/swift/latest/) server. This also allows you to have a different hostname than the one from the Swift service.

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ juju deploy ./content-cache-k8s_ubuntu-20.04-amd64.charm \

## Canonical contributor agreement

Canonical welcomes contributions to the Content-cache-k8s Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.
Canonical welcomes contributions to the Content-cache-k8s Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.
16 changes: 0 additions & 16 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,3 @@ the majority of Canonical's web properties including [ubuntu.com](https://ubuntu
[canonical.com](https://canonical.com), and [Ubuntu Extended Security Maintenance](https://ubuntu.com/security/esm).

For DevOps or SRE teams this charm will make operating it simple and straightforward through Juju's clean interface.

# Navigation

| Level | Path | Navlink |
| -- | -- | -- |
| 1 | tutorial | [Tutorial]() |
| 2 | tutorial-getting-started | [Quick Guide](/t/content-cache-k8s-docs-quick-guide/8651) |
| 1 | how-to | [How to]() |
| 2 | how-to-contribute | [Contribute](/t/content-cache-k8s-docs-contributing/8617) |
| 2 | how-to-cache-content-with-openstack-swift | [Cache content with OpenStack/Swift storage](/t/content-cache-k8s-docs-content-cache-with-openstack-swift-storage/8619) |
| 1 | reference | [Reference]() |
| 2 | reference-actions | [Actions](/t/content-cache-k8s-docs-actions/8715) |
| 2 | reference-configurations | [Configurations](/t/content-cache-k8s-docs-configurations/8714) |
| 2 | reference-integrations | [Integrations](/t/content-cache-k8s-docs-integrations/8713) |
| 1 | explanation | [Explanation]() |
| 2 | explanation-charm-architecture | [Charm architecture](/t/content-cache-k8s-docs-charm-architecture/8712) |
2 changes: 1 addition & 1 deletion docs/reference/actions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Actions

See [Actions](https://charmhub.io/content-cache-k8s/actions).
See [Actions](https://charmhub.io/content-cache-k8s/actions).
2 changes: 1 addition & 1 deletion docs/reference/configurations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Configurations

See [Configure](https://charmhub.io/content-cache-k8s/configure).
See [Configure](https://charmhub.io/content-cache-k8s/configure).
2 changes: 1 addition & 1 deletion docs/reference/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ This charm integrates with:

- [Prometheus](https://prometheus.io/)

See more information in [Charm Architecture](https://charmhub.io/content-cache-k8s/docs/charm-architecture).
See more information in [Charm Architecture](https://charmhub.io/content-cache-k8s/docs/charm-architecture).
2 changes: 1 addition & 1 deletion docs/tutorial/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ The default hostname for the Hello-kubecon application is `hello-kubecon`. To be
127.0.0.1 hello-kubecon
```

After that, visit `http://hello-kubecon` in a browser and you'll be presented with the home screen of the Hello-kubecon application.
After that, visit `http://hello-kubecon` in a browser and you'll be presented with the home screen of the Hello-kubecon application.
Loading