Skip to content

Commit 62892d8

Browse files
md: improve authoring guidelines for deployment guides
1 parent 6da6e3c commit 62892d8

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CLAUDE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,20 +67,25 @@ The project extends Docusaurus with specialized components in `src/components/`:
6767

6868
## Authoring guidelines
6969

70+
1. Do not number headings
71+
2. Do not use horizontal rules
72+
3. Do not use blockquotes as callouts
73+
4. Use formatting like emphasis and italics VERY sparsely
74+
7075
### Writing deployment guides
7176

7277
When writing deployment guides for applications, databases, or other services that should run in containers, follow the following structure:
7378

7479
1. Deploying the workload
7580
1. Deployment via Terraform (recommended)
76-
- relevant documentation:
81+
- BEFORE writing examples, read the following documentation:
7782
- https://registry.terraform.io/providers/mittwald/mittwald/latest/docs/resources/container_stack
7883
- https://registry.terraform.io/providers/mittwald/mittwald/latest/docs/data-sources/container_image
7984
2. Deployment via mStudio UI
8085
3. Imperative deployment on the CLI via `mw container run` command
8186
- relevant documentation:
8287
- https://docs.mittwald.de/cli/container/run/
83-
- search the Docher Hub for documentation on the relevant images
88+
- search the Docker Hub for documentation on the relevant images
8489
4. Declarative deployment on the CLI via `mw stack deploy` command
8590
2. Operations; in this section, include any operational tasks that are required to run the workload, such as backups, monitoring, or logging.
86-
3. Integrations; in this section, describe integrations in common CMS platforms such as WordPress, Drupal, TYPO3 or Joomla.
91+
3. Integrations; in this section, describe integrations in common CMS platforms such as WordPress, Drupal, TYPO3 or Joomla. Do not suggest integrations that would require writing a custom plugin or anything of the sort.

0 commit comments

Comments
 (0)