Skip to content

Commit

Permalink
Make 2024-07 release
Browse files Browse the repository at this point in the history
  • Loading branch information
dariavladykina committed Jul 24, 2024
1 parent 62770fe commit b63e1b1
Show file tree
Hide file tree
Showing 18 changed files with 9,346 additions and 8,905 deletions.
89 changes: 46 additions & 43 deletions xml/docu_styleguide.asciidoc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,54 @@
%entities;
]>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sec-asciidoc">
<title>Working with AsciiDoc</title>

<para>To create documentation in the AsciiDoc format,
adhere to the comprehensive guide at <link xlink:href="https://asciidoctor.org/docs/asciidoc-recommended-practices"/>.
</para>
<para>We also recommend the guidance on AsciiDoc provided in the
<link xlink:href="https://documentation.suse.com/trd/contributors/single-html/suse-trd_contrib-guide/#id-asciidoc/">SUSE Technical Reference Documentation Contributors Guide</link>.</para>
<para>
The following things are important when working with AsciiDoc:
</para>
<itemizedlist>
<listitem>
<para>
Only use formatting that is supported by the AsciiDoctor tool.
Ignore features that are only documented for the outdated
<command>asciidoc</command> (Python) tool. In particular, ignore the
documentation at <literal>https://powerman.name</literal>.
<!-- Intentionally not linked. -->
</para>
</listitem>
<listitem>
<para>
Most recommendations from
<link xlink:href="https://github.com/SUSE/doc-susemanager/wiki/markup-syntax"/>
are applicable generally. Some recommendations, however, are specific to
&suse; Manager documentation, in particular:
</para>
<itemizedlist>
<title>Working with AsciiDoc</title>
<para>
To create documentation in the AsciiDoc format, adhere to the comprehensive
guide at
<link xlink:href="https://asciidoctor.org/docs/asciidoc-recommended-practices"/>.
</para>
<para>
We also recommend the guidance on AsciiDoc provided in the
<link xlink:href="https://documentation.suse.com/trd/contributors/single-html/suse-trd_contrib-guide/#id-asciidoc/">SUSE
Technical Reference Documentation Contributors Guide</link>.
</para>
<para>
The following things are important when working with AsciiDoc:
</para>
<itemizedlist>
<listitem>
<para>
The section <citetitle>Images</citetitle>&mdash;images need to be added
the same way they are added in other DAPS-based documentation, under the
<filename>images/src/<replaceable>FORMAT</replaceable></filename>
directory of the repo.
</para>
<para>
Only use formatting that is supported by the AsciiDoctor tool. Ignore
features that are only documented for the outdated
<command>asciidoc</command> (Python) tool. In particular, ignore the
documentation at <literal>https://powerman.name</literal>.
<!-- Intentionally not linked. -->
</para>
</listitem>
<listitem>
<para>
The section <citetitle>Working with Drafts</citetitle>&mdash;there is
currently no equivalent standard functionality.
</para>
<para>
Most recommendations from
<link xlink:href="https://github.com/SUSE/doc-susemanager/wiki/markup-syntax"/>
are applicable generally. Some recommendations, however, are specific
to &suse; Manager documentation, in particular:
</para>
<itemizedlist>
<listitem>
<para>
The section <citetitle>Images</citetitle>&mdash;images need to be
added the same way they are added in other DAPS-based
documentation, under the
<filename>images/src/<replaceable>FORMAT</replaceable></filename>
directory of the repo.
</para>
</listitem>
<listitem>
<para>
The section <citetitle>Working with Drafts</citetitle>&mdash;there
is currently no equivalent standard functionality.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>


</itemizedlist>
</chapter>
Loading

0 comments on commit b63e1b1

Please sign in to comment.