Skip to content

Commit

Permalink
docs: fix duplicate labels, removed Release Notes as they are generat…
Browse files Browse the repository at this point in the history
…ed from changelog now
  • Loading branch information
pstorz committed Sep 24, 2021
1 parent 968d6a8 commit f4826a6
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 74 deletions.
32 changes: 16 additions & 16 deletions docs/manuals/source/DeveloperGuide/jobexec.rst
Expand Up @@ -31,26 +31,26 @@ As there are lots of configuration options that will change the job execution in

When such a job is run, the |dir| connects to the |sd| and does the initial job setup, then the |dir| connects to the |fd| to setup and start the job there. The |fd| then connects to the |sd| and sends it data there.

Overview
~~~~~~~~
Overview simple backup job
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. uml:: /DeveloperGuide/jobexec/backup-short.puml


Detailed View
~~~~~~~~~~~~~
Detailed View simple backup job
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. uml:: /DeveloperGuide/jobexec/backup-long.puml

Simple restore job
------------------

Overview
~~~~~~~~
Overview simple restore job
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. uml:: /DeveloperGuide/jobexec/restore-short.puml


Detailed View
~~~~~~~~~~~~~
Detailed View simple restore job
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. uml:: /DeveloperGuide/jobexec/restore-long.puml


Expand All @@ -61,12 +61,12 @@ None of the data is transferred over the network.

When such a job is run, the |dir| connects to the |sd| and tells is what data to read from which volume and what volume the records should be written to.

Overview
~~~~~~~~
Overview local copy job
~~~~~~~~~~~~~~~~~~~~~~~
.. uml:: /DeveloperGuide/jobexec/localcopy-short.puml

Detailed View
~~~~~~~~~~~~~
Detailed View local copy job
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. uml:: /DeveloperGuide/jobexec/localcopy-long.puml


Expand All @@ -79,10 +79,10 @@ The main difference is what the director writes to the catalog after the job is
When such a remote copy or migrate job is run, the |dir| connects to the reading |sd| and then to the writing |sd|.
The writing |sd| is put into listen-mode while the writing |sd| will essentially run a restore where the data is sent to the writing |sd|.

Overview
~~~~~~~~
Overview remote copy job
~~~~~~~~~~~~~~~~~~~~~~~~
.. uml:: /DeveloperGuide/jobexec/remotecopy-short.puml

Detailed View
~~~~~~~~~~~~~
Detailed View remote copy job
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. uml:: /DeveloperGuide/jobexec/remotecopy-long.puml
24 changes: 12 additions & 12 deletions docs/manuals/source/DeveloperGuide/netprotocol.rst
Expand Up @@ -288,38 +288,38 @@ Detailed Diagram
Restore of a Single File
~~~~~~~~~~~~~~~~~~~~~~~~

Overview
^^^^^^^^
Overview single file restore
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml:: netprotocol/restore_of_one_file_overview.puml

Detailed Diagram
^^^^^^^^^^^^^^^^
Detailed Diagram single file restore
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml:: netprotocol/restore_of_one_file.puml

Migration of a Single Volume
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Overview
^^^^^^^^
Overview single volume migration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml:: netprotocol/migration_of_one_volume_overview.puml

Detailed Diagram
^^^^^^^^^^^^^^^^
Detailed Diagram single volume migration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml:: netprotocol/migration_of_one_volume.puml

Verify of a Single File (Mode: Volume to Catalog)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Overview
^^^^^^^^
Overview single file verify
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml:: netprotocol/verify_one_file_volume_to_catalog_overview.puml

Detailed Diagram
^^^^^^^^^^^^^^^^
Detailed Diagram single file verify
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml:: netprotocol/verify_one_file_volume_to_catalog.puml
Expand Up @@ -55,32 +55,6 @@ Note
Until defined otherwise, you should use ``:sinceVersion:`` instead of these.


Release Notes
-------------

If you want to display the release notes of a Bareos stable release, use the following template:

.. \newcommand{\releasenote}[2]{
\subsection*{bareos-#1}
\addcontentsline{toc}{subsection}{\protect\numberline{}#1}%
\label{bareos-#1}
\index[general]{bareos-#1!Release Notes}%
#2
}
.. literalinclude:: /DocumentationStyleGuide/example/releasenotes-template.rst.inc

Example:

.. literalinclude:: /DocumentationStyleGuide/example/releasenotes-17.2.7.rst.inc


See the output at :ref:`bareos-17.2.7`\ .

.. COMMENT include:: /DocumentationStyleGuide/example/releasenotes.rst.inc
Reference to a Release
----------------------

Expand All @@ -90,27 +64,11 @@ To refer to a release, use::

Example:

This refers to :ref:`bareos-17.2.7`\ .
This refers to :ref:`bareos-20.0.0`\ .

Output:

This refers to :ref:`bareos-17.2.7`\ .


.. Release Notes - Unstable Version
--------------------------------
TODO: required?
If you want to display the release notes of a bareos unstable release, the following formatting should be used:
.. \newcommand{\releasenoteUnstable}[2]{
\subsection*{\textit{bareos-#1 (unstable)}}
%\addcontentsline{toc}{subsection}{\protect\numberline{}#1}%
%\index[general]{bareos-#1!Release Notes}%
#2
}
This refers to :ref:`bareos-20.0.0`\ .


URLs
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/source/IntroductionAndTutorial/Tutorial.rst
Expand Up @@ -632,8 +632,8 @@ The :file:`/etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/
scp /etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/bareos-dir.conf root@client2.example.com:/etc/bareos/bareos-fd.d/director/
Manual configuration
^^^^^^^^^^^^^^^^^^^^
Manual configuration of client
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Alternatively you can configure your resources manually. On the |dir| create the file

Expand Down

0 comments on commit f4826a6

Please sign in to comment.