Skip to content

Commit

Permalink
Revise Docker Compose documentation
Browse files Browse the repository at this point in the history 
Updated the Docker Compose documentation to feature specific configurations for Elsa and associated services, prominently highlighting PostgreSQL and Traefik settings. Improvements include clearer spotlight topics and a streamlined approach to advanced configurations, facilitating easier navigation and understanding for users.
  • Loading branch information
@sfmskywalker
sfmskywalker committed Dec 1, 2024
1 parent 8c9b288 commit 28deba7
Showing 1 changed file with 8 additions and 93 deletions.
101 changes: 8 additions & 93 deletions writerside/topics/Docker-Compose.topic
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,107 +5,22 @@
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Docker Compose" id="Docker-Compose">

<!-- A section combines multiple topics dedicated to a specific subject.
Add a starting page to provide an overview of the topics in the section.
Start with two topics you want to promote in the <spotlight> group,
several important topics in the <primary> group (for example, where to start),
several less important topics in the <secondary> group (for example, more advanced topics),
and optionally add any other relevant topics in the <misc> group as cards and lists of links
(maybe related topics from other sections).
Only the spotlight section is limited to two topics.
For other groups, try to keep the number between 2 and 6, but you can add more if necessary.-->

<section-starting-page>
<title>Section starting page title</title>
<title>Docker Compose Configurations for Elsa</title>
<description>
Add an introductory paragraph: explain what this section is about in 2-3 short sentences.
Explore various Docker Compose configurations for setting up Elsa and related services like PostgreSQL and Traefik. Use these configurations to quickly spin up environments for development, testing, or production.
</description>

<!-- Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon. -->
<spotlight>
<a href="" type="account" summary="This overrides the card summary of the topic">Custom card title</a>
<a href="" type="search" summary="This overrides the card summary of the topic">Another custom title</a>
<a href="Elsa-Studio-Server.topic" type="container" summary="Setup an environment with Elsa Studio and Server">Separate Elsa Studio + Server</a>
<a href="Elsa-Server-Studio-Single-Image.topic" type="search" summary="Use a single image for Elsa Studio and Server">Single Image Configuration</a>
</spotlight>

<!-- Add several topics that are most important for this section. -->
<primary>
<title>Get started</title>
<a href=""/>
<a href="" summary="With a custom card summary"/>
<a href="">Custom card title</a>
<a href="" summary="With a custom card summary">Custom card title</a>
<title>Advanced Configurations</title>
<a href="Persistent-Database.topic" summary="Learn how to configure PostgreSQL">PostgreSQL Setup</a>
<a href="Traefik.topic" summary="Configure Traefik for routing and load balancing">Traefik Configuration</a>
</primary>

<!-- Add several topics that are less important or are relevant only for advanced/experienced users. -->
<secondary>
<title>Explore advanced features</title>
<a href=""/>
<a href="" summary="With a custom card summary"/>
<a href="">Custom card title</a>
<a href="" summary="With a custom card summary">Custom card title</a>
</secondary>

<!-- Optionally add additional cards and links to topics that are not in this section but may be relevant. -->
<misc>
<cards>
<title>Other relevant topics as wide cards</title>
<a href=""/>
<a href="" summary="With a custom card summary"/>
<a href="">Custom card title</a>
<a href="" summary="With a custom card summary">Custom card title</a>
</cards>

<cards narrow="true">
<title>Other relevant topics as narrow cards</title>
<a href=""/>
<a href=""/>
<a href="" summary="With a custom card summary"/>
<a href="">Custom card title</a>
<a href="">Custom card title</a>
<a href="" summary="With a custom card summary">Custom card title</a>
</cards>

<links>
<group>
<title>Other related topics as links</title>
<a href=""/>
<a href="" summary="With a custom card summary"/>
<a href="">Custom card title</a>
<a href="" summary="With a custom card summary">Custom card title</a>
</group>
<group>
<title>Two in a row</title>
<a href=""/>
<a href="" summary="With a custom card summary"/>
<a href="">Custom card title</a>
<a href="" summary="With a custom card summary">Custom card title</a>
</group>
</links>

<links narrow="true">
<group>
<title>More related topics</title>
<a href=""/>
<a href="" summary="With a custom card summary"/>
<a href="">Custom card title</a>
<a href="" summary="With a custom card summary">Custom card title</a>
</group>
<group>
<title>Three in a row</title>
<a href=""/>
<a href=""/>
<a href="">Custom card title</a>
<a href="">Custom card title</a>
</group>
<group>
<title>Each group is narrow</title>
<a href=""/>
<a href=""/>
<a href="">Custom card title</a>
<a href="">Custom card title</a>
</group>
</links>
</misc>
</section-starting-page>

</topic>
</topic>

0 comments on commit 28deba7

Please sign in to comment.