Skip to content

Commit 01e2a2b

Browse files
authored
Docs: How-to landing and organization (#257)
* docs: add how-to landing page * docs: basic landing page structure * docs: initial sorting * docs: add Discourse links * docs: reorder basic operations * docs: reorder TOC in overview * fix: update links to Markdown files * update index.md to remove nested reference
1 parent 9101224 commit 01e2a2b

File tree

2 files changed

+52
-7
lines changed

2 files changed

+52
-7
lines changed

docs/how-to/index.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# How-to guides
2+
3+
The following guides cover key processes and common tasks for managing
4+
and using the WordPress charm.
5+
6+
## Initial setup
7+
* [Retrieve initial credentials]
8+
* [Configure initial settings]
9+
10+
## Basic operations
11+
* [Configure hostname]
12+
* [Configure object storage]
13+
* [Install plugins]
14+
* [Install themes]
15+
* [Integrate with COS]
16+
17+
## Security
18+
* [Enable antispam]
19+
* [Enable WAF]
20+
* [Rotate secrets]
21+
22+
## Upgrade and redeployment
23+
* [Upgrade WordPress charm]
24+
* [Redeploy]
25+
26+
## Development
27+
* [Contribute]
28+
29+
<!--Links-->
30+
31+
[Retrieve initial credentials]: retrieve-initial-credentials.md
32+
[Configure initial settings]: configure-initial-settings.md
33+
[Integrate with COS]: integrate-with-cos.md
34+
[Configure hostname]: configure-hostname.md
35+
[Install plugins]: install-plugins.md
36+
[Install themes]: install-themes.md
37+
[Configure object storage]: configure-object-storage.md
38+
[Enable antispam]: enable-antispam.md
39+
[Enable WAF]: enable-waf.md
40+
[Rotate secrets]: rotate-secrets.md
41+
[Upgrade WordPress charm]: upgrade-wordpress-charm.md
42+
[Redeploy]: redeploy.md
43+
[Contribute]: contribute.md

docs/index.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,19 @@ Thinking about using the WordPress Operator for your next project? [Get in touch
3434

3535
1. [Tutorial](tutorial.md)
3636
1. [How-to](how-to)
37-
1. [Contribute](how-to/contribute.md)
38-
1. [Integrate with COS](how-to/integrate-with-cos.md)
39-
1. [Enable antispam](how-to/enable-antispam.md)
40-
1. [Enable WAF](how-to/enable-waf.md)
41-
1. [Configure hostname](how-to/configure-hostname.md)
42-
1. [Configure initial settings](how-to/configure-initial-settings.md)
4337
1. [Retrieve initial credentials](how-to/retrieve-initial-credentials.md)
38+
1. [Configure initial settings](how-to/configure-initial-settings.md)
39+
1. [Configure hostname](how-to/configure-hostname.md)
40+
1. [Configure object storage](how-to/configure-object-storage.md)
4441
1. [Install plugins](how-to/install-plugins.md)
4542
1. [Install themes](how-to/install-themes.md)
46-
1. [Configure object storage](how-to/configure-object-storage.md)
43+
1. [Integrate with COS](how-to/integrate-with-cos.md)
44+
1. [Enable antispam](how-to/enable-antispam.md)
45+
1. [Enable WAF](how-to/enable-waf.md)
4746
1. [Rotate secrets](how-to/rotate-secrets.md)
47+
1. [Upgrade WordPress charm](how-to/upgrade-wordpress-charm.md)
48+
1. [Redeploy](how-to/redeploy.md)
49+
1. [Contribute](how-to/contribute.md)
4850
1. [Reference](reference)
4951
1. [Actions](reference/actions.md)
5052
1. [Configurations](reference/configurations.md)

0 commit comments

Comments
 (0)