Skip to content

Commit 03f5598

Browse files
ISD-5226 update docs landing pages (#387)
* update how-to landing page * Update docs/how-to/index.md Co-authored-by: Erin Conley <erin.conley@canonical.com> * add summary for each section * Update docs/how-to/index.md Co-authored-by: Erin Conley <erin.conley@canonical.com> * Update docs/how-to/index.md Co-authored-by: Erin Conley <erin.conley@canonical.com> * Update docs/how-to/index.md Co-authored-by: Erin Conley <erin.conley@canonical.com> --------- Co-authored-by: Erin Conley <erin.conley@canonical.com>
1 parent 09ba758 commit 03f5598

1 file changed

Lines changed: 32 additions & 4 deletions

File tree

docs/how-to/index.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,42 @@ myst:
1010

1111
The following guides cover key processes and common tasks for managing and using the HAProxy charm.
1212

13+
## Common use-cases
14+
15+
Once you've set up the HAProxy charm, you can take advantage of the built-in features and capabilities to customize the charm based on your specific needs and use case.
16+
1317
```{toctree}
1418
:maxdepth: 1
15-
Configure high availability <configure-high-availability.md>
16-
Configure virtual IP on OpenStack <configure-virtual-ip-on-openstack.md>
1719
Integrate with non-charm workloads <integrate-with-non-charm-workload.md>
1820
Provide extra configurations for ingress requirer charms <provide-extra-configurations-for-ingress-requirer-charms.md>
19-
Upgrade <upgrade.md>
2021
Protect a hostname using OpenID Connect <protect-hostname-spoe-auth.md>
21-
Contribute <contribute.md>
2222
Enable DDoS Protection <enable-ddos-protection.md>
23+
Configure high availability <configure-high-availability.md>
24+
```
25+
26+
## Platform-specific workflows
27+
28+
In some cases additional steps need to be performed on specific substrates to ensure that the charm is working as intended.
29+
30+
```{toctree}
31+
:maxdepth: 1
32+
Configure virtual IP on OpenStack <configure-virtual-ip-on-openstack.md>
33+
```
34+
35+
## Maintenance
36+
37+
This section contains how-to guides for maintenance actions that you might need to take while operating the charm.
38+
39+
```{toctree}
40+
:maxdepth: 1
41+
Upgrade <upgrade.md>
42+
```
43+
44+
## Development
45+
46+
This section contains how-to guides for developing the charm.
47+
48+
```{toctree}
49+
:maxdepth: 1
50+
Contribute <contribute.md>
2351
```

0 commit comments

Comments
 (0)