Added an entity.

articles/docker-compose.asm.xml

@@ -32,10 +32,10 @@
   <!-- Concept files -->
   <resources>
     <resource xml:id="_docker-compose-podman-docker" href="../concepts/docker-compose-podman-docker.xml">
-      <description>About docker-compose</description>
+      <description>About &compose;</description>
     </resource>
     <resource xml:id="_docker-compose-about" href="../concepts/docker-compose-about.xml">
-      <description>About docker-compose</description>
+      <description>About &compose;</description>
     </resource>
 
   </resources>
@@ -66,8 +66,8 @@
   <!-- S T R U C T U R E -->
   <structure renderas="article" xml:id="docker-compose" xml:lang="en">
     <merge>
-      <title>Managing multi-container applications using <literal>docker-compose</literal></title>
-      <subtitle>Subtitle if necessary</subtitle>
+      <title>Managing multi-container applications using <literal>&compose;</literal></title>
+
       <!-- Create revision history to enable versioning; add most recent entries at the top. -->
       <!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
       <revhistory xml:id="rh-USE-ROOT-ID">

concepts/docker-compose-about.xml

@@ -10,33 +10,33 @@
 <!-- point back to this document with a similar comment added to your legacy doc piece -->
 <!-- refer to README.md for file and id naming conventions -->
 <!-- metadata is dealt with on the assembly level -->
-<topic xml:id="compose-docker-compose-about"
+<topic xml:id="compose-about"
  role="concept" xml:lang="en"
  xmlns="http://docbook.org/ns/docbook" version="5.2"
  xmlns:its="http://www.w3.org/2005/11/its"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:trans="http://docbook.org/ns/transclusion">
   <info>
-    <title>Overview of Compose</title><!-- can be changed via merge in the assembly -->
+    <title>Overview of &compose;</title><!-- can be changed via merge in the assembly -->
     <!--add author's email address-->
     <meta name="maintainer" content="[email protected]" its:translate="no"/>
     <abstract><!-- can be changed via merge in the assembly -->
       <para>
-       The topic describes basics of the Compose tool.
+       The topic describes basics of the &compose; tool.
       </para>
     </abstract>
   </info>
-  <section xml:id="concept-example-what-is">
-    <title>What is Compose?</title>
+  <section xml:id="compose-about-what-is">
+    <title>What is &compose;?</title>
     <para>
-      Compose is a tool for managing multi-container applications. Compose enables you to
+      &compose; is a tool for managing multi-container applications. &compose; enables you to
       have multiple isolated environment on a single host, recreate only those containers that have
       changed and supporit variables between environments.
     </para>
   </section>
-  <section xml:id="concept-example-how-it-works">
-    <title>How does Compose work?</title>
+  <section xml:id="compose-about-how-it-works">
+    <title>How does &compose; work?</title>
     <para>
       First, you need to create a YAML file that define your application. In the file, you need to
       define the following components:  
@@ -72,7 +72,13 @@
       You may also need to use a list of environment variables that will be passed to your services.
     </para>
     <para>
-      After you create the YAML file, you can manage your compose application using the compose CLI.
+      After you create the YAML file, you can manage your application using the &compose; CLI.
+    </para>
+  </section>
+  <section xml:id="compose-about-installation">
+    <title>Where to get &compose;?</title>
+    <para>
+      &compose; is present on &productnameshort; by default and can be used out of the box.
     </para>
   </section>
 

concepts/podman-about.xml

@@ -18,7 +18,7 @@
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:trans="http://docbook.org/ns/transclusion">
   <info>
-    <title>Concept</title><!-- can be changed via merge in the assembly -->
+    <title>About &podman;</title><!-- can be changed via merge in the assembly -->
     <!--add author's email address-->
     <meta name="maintainer" content="[email protected]" its:translate="no"/>
     <abstract><!-- can be changed via merge in the assembly -->

references/docker-compose-yaml-file.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE topic
+[
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<!-- metadata is dealt with on the assembly level -->
+<topic xml:id="compose-yaml-file"
+ role="reference" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook" version="5.2"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+   <title>The <filename>compose.yml</filename> file</title><!-- can be changed via merge in the assembly -->
+    <!--add author's email address-->
+    <meta name="maintainer" content="[email protected]" its:translate="no"/>
+    <abstract><!-- can be changed via merge in the assembly -->
+      <para>
+       Introductory text
+      </para>
+    </abstract>
+  </info>
+
+  <section xml:id="compose-yaml-file-top-level">
+    <title>The</title>
+    <para>
+      A paragraph of text.
+    </para>
+    <variablelist>
+      <title>A title</title>
+      <varlistentry>
+        <term><command>a-command --with-options</command></term>
+        <listitem>
+          <para>
+            A paragraph of text.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><command>another-command --with-options</command></term>
+        <listitem>
+          <para>
+            Another paragraph of text.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+    <table>
+      <title>A table title</title>
+      <tgroup cols="2">
+        <colspec colwidth="50*"/>
+        <colspec colwidth="50*"/>
+        <tbody>
+          <row>
+            <entry>an entry</entry>
+            <entry>another entry</entry>
+          </row>
+          <row>
+            <entry>an entry</entry>
+            <entry>another entry</entry>
+          </row>
+          <row>
+            <entry>an entry</entry>
+            <entry>another entry</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+  </section>
+</topic>

tasks/docker-compose-create-application.xml

@@ -10,7 +10,7 @@
 <!-- point back to this document with a similar comment added to your legacy doc piece -->
 <!-- refer to README.md for file and id naming conventions -->
 <!-- metadata is dealt with on the assembly level -->
-<topic xml:id="task-example"
+<topic xml:id="compose-creating-application"
  role="task" xml:lang="en"
  xmlns="http://docbook.org/ns/docbook" version="5.2"
  xmlns:its="http://www.w3.org/2005/11/its"
@@ -24,75 +24,29 @@ in the assembly -->
     <meta name="maintainer" content="[email protected]" its:translate="no"/>
     <abstract><!-- can be changed via merge in the assembly -->
       <para>
-       By using Compose you can create and start a container-based application.
+       By using &compose; you can create and start a container-based application.
       </para>
     </abstract>
   </info>
-  <section xml:id="task-example-introduction">
-    <title>Introduction</title>
-    <para>
-      A paragraph of text.
-    </para>
-  </section>
-  <section xml:id="task-example-requirements">
-    <title>Requirements</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-          An
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          Unordered
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          List
-        </para>
-      </listitem>
-    </itemizedlist>
-    <para>
-      A paragraph of text.
-    </para>
-  </section>
-  <section xml:id="task-example-executing">
-    <title>Executing the task</title>
-    <para>
-      A paragraph of text.
-    </para>
-    <procedure>
+  <para>
+  The procedure of creating and starting a container-based application can be summarized into the following steps:
+  </para>
+  <procedure>
+    <step>
       <para>
-        A short introduction to the procedure.
+Prepare the <filename>compose.yml</filename> file.
       </para>
-      <step>
-        <para>
-          A step.
-        </para>
-      </step>
-      <step>
-        <para>
-          A second step.
-        </para>
-      </step>
-      <step>
-        <para>
-          A third step.
-        </para>
-      </step>
-    </procedure>
-  </section>
-  <section xml:id="task-example-summary">
-    <title>Summary</title>
-    <para>
-      A paragraph of text, summing up the result of the task.
-    </para>
-  </section>
-  <section xml:id="task-example-troubleshooting">
-    <title>Troubleshooting</title>
-    <para>
-      Add some troubleshooting information, if applicable.
-    </para>
-  </section>
+    </step>
+    <step>
+      <para>
+        Prepare the environment variables file.
+      </para>
+    </step>
+    <step>
+      <para>
+        Use &compose; to start the application.
+      </para>
+    </step>
+  </procedure>
+
 </topic>