Skip to content

Rewrite Listmonk deployment guide to follow APP-GUIDES authoring guidelines#955

Merged
martin-helmich merged 8 commits intopatch-3from
copilot/sub-pr-954
Feb 17, 2026
Merged

Rewrite Listmonk deployment guide to follow APP-GUIDES authoring guidelines#955
martin-helmich merged 8 commits intopatch-3from
copilot/sub-pr-954

Conversation

Copy link
Contributor

Copilot AI commented Feb 13, 2026

  • Review APP-GUIDES.instructions.md and example guides
  • Create English version of Listmonk deployment guide (docs/guides/apps/listmonk.md)
  • Rewrite German version to follow APP-GUIDES structure
  • Ensure both versions follow proper structure:
    • Front matter (sidebar_label, description - no title)
    • H1 title: "Running Listmonk"
    • Introduction section with app description and official docs quote
    • Prerequisites section with correct PostgreSQL guide link
    • "How do I start the container?" section with subsections:
      • Using Terraform (Recommended) - with correct .image attribute references
      • Using mStudio UI (detailed walkthrough with ssl_mode)
      • Alternative: mw container run (with ssl_mode)
      • Alternative: mw stack deploy (with ssl_mode)
    • Operation/Post-deployment section
      • Assign Domain section with urgent security warning
      • Database Setup section (with ssl_mode)
      • Backups section
    • Further Resources section
  • Use proper formatting (bold for UI elements, proper callouts, etc.)
  • Add urgent security warnings for immediate admin account creation
  • Ensure Docker image is properly referenced with Docker Hub link
  • Implement idempotent initialization matching official docker-compose format
  • Use consistent command format: ["sh", "-c", "..."] without entrypoint modification
  • Fixed Terraform to use .image attribute instead of .name
  • Added LISTMONK_db__ssl_mode = "disable" to all deployment variants
  • Standardized heading anchor IDs across English and German versions
  • All H3 headings now have explicit anchor IDs
  • Anchor IDs are consistent between English and German (e.g., both use #terraform, #mstudio-ui, etc.)
  • Remove manual post-installation steps (no longer needed)
  • Run code review (passed with no comments)
  • Run security scanning (no issues found)

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: martin-helmich <2538958+martin-helmich@users.noreply.github.com>
Copilot AI changed the title [WIP] Update Listmonk deployment guide to comply with authoring guidelines Rewrite Listmonk deployment guide to follow APP-GUIDES authoring guidelines Feb 13, 2026
Copilot AI requested a review from martin-helmich February 13, 2026 15:22
Co-authored-by: martin-helmich <2538958+martin-helmich@users.noreply.github.com>
Copilot AI requested a review from martin-helmich February 13, 2026 15:51
@martin-helmich martin-helmich marked this pull request as ready for review February 16, 2026 15:39
…ent initialization

Co-authored-by: martin-helmich <2538958+martin-helmich@users.noreply.github.com>
…hen security warnings

Co-authored-by: martin-helmich <2538958+martin-helmich@users.noreply.github.com>
Co-authored-by: martin-helmich <2538958+martin-helmich@users.noreply.github.com>
Dieser Befehl liest die `docker-compose.yml`-Datei aus dem aktuellen Verzeichnis und stellt sie auf deinem Standard-Stack bereit.

#### Domain mit dem Container verknüpfen
## Domain zuweisen {#domain-zuweisen}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot you're using the heading anchor IDs inconsistently, contrary to your explicit instructions.

  1. Have heading anchors for all subheadings
  2. Should be the same in the german translation as in the english original

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed! Standardized all heading anchor IDs:

  1. Added anchor IDs to all H3 headings in both languages:

    • #terraform
    • #mstudio-ui
    • #mw-container-run
    • #mw-stack-deploy
    • #database-setup
    • #backups
  2. Made H4 anchor IDs consistent between English and German:

    • #entrypoint-and-command (was #ui-entrypoint-and-command in EN, #ui-entrypoint-und-command in DE)
    • #volumes (was #ui-volumes)
    • #environment-variables (was #ui-environment-variables in EN, #ui-umgebungsvariablen in DE)
  3. Fixed H2 anchor consistency:

    • Changed German #domain-zuweisen to #assign-domain to match English
    • Changed German #datenbank-setup to #database-setup to match English

All anchor IDs are now technical/English-based and identical across both language versions for stable linking.

Commit: 29e266d

martin-helmich and others added 2 commits February 17, 2026 13:06
Signed-off-by: Martin Helmich <kontakt@martin-helmich.de>
Co-authored-by: martin-helmich <2538958+martin-helmich@users.noreply.github.com>
@martin-helmich martin-helmich merged commit 29e927f into patch-3 Feb 17, 2026
1 of 2 checks passed
@martin-helmich martin-helmich deleted the copilot/sub-pr-954 branch February 17, 2026 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants