Skip to content

Commit

Permalink
xml: manual rewrite of some xml:id values
Browse files Browse the repository at this point in the history
For SEO optimization, we need to avoid the use of dots ('.') and underscores
('_') in our xml:id values.

Signed-off-by: Nathan Cutler <[email protected]>
  • Loading branch information
smithfarm committed Jul 11, 2024
1 parent 32a41c7 commit fb43e8a
Show file tree
Hide file tree
Showing 20 changed files with 164 additions and 165 deletions.
28 changes: 14 additions & 14 deletions xml/obs_ag_administration.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@
<xi:include href="obs_ag_unpublish_hooks.xml"/>
<xi:include href="obs_ag_user_management.xml"/>
<xi:include href="obs_ag_message_bus.xml"/>
<sect1 xml:id="_backup">
<sect1 xml:id="backup">
<title>Backup</title>
<para>
&obs; configuration and content needs usually a backup. The following explains
suggested strategies and places considered for a backup.
</para>

<sect2 xml:id="_backup_places">
<sect2 xml:id="backup-backup-places">
<title>Places to consider</title>
<para>The following is pointing to the places with admin configurations or user content.
The default location places are considered here.
</para>
<sect3 xml:id="_backup_configuration_frontend">
<sect3 xml:id="backup-backup-places-backup-configuration-frontend">
<title>Frontend Configuration</title>
<itemizedlist>
<listitem>
Expand All @@ -43,41 +43,41 @@
<para>The configuration is not changing usually. It is enough to backup it after config changes.
</para>
</sect3>
<sect3 xml:id="_backup_database_frontend">
<sect3 xml:id="backup-backup-places-backup-database-frontend">
<title>Frontend Database</title>
<para>The MySQL/MariaDB database backup can be done in different ways. Please consider the database
manual for details. One possible way is to create dumps via mysqldump tool. The backup should be
done at the same point of time as the source server. Inconsistencies can be resolved
using the check_consistency tool.</para>
</sect3>
<sect3 xml:id="_backup_backend_configuration">
<sect3 xml:id="backup-backup-places-backup-backend-configuration">
<title>Backend Configuration</title>
<para>The backend has a single configuration file which may got altered. This is by default
/usr/lib/obs/server/BSConfig.pm . The file is not supposed to be changed usually and
it can only be done by the system root user. A backup after a change is sufficient.
</para>
</sect3>
<sect3 xml:id="_backup_backend_content">
<sect3 xml:id="backup-backup-places-backup-backend-content">
<title>Backend Content</title>
<para>All backend content is below /srv/obs directory. This include the sources, build results and
also all configuration changes done by the OBS admin users.
</para>
</sect3>
</sect2>
<sect2 xml:id="_backup_strategies">
<sect2 xml:id="backup-backup-strategies">
<title>Backup strategies</title>
<para>
A backup is ideally taken only from a not running service. In real live this is
usually not possible, so it is important to run a backup on a production system.
</para>
<sect3 xml:id="_backup_strategy_database">
<sect3 xml:id="backup-backup-strategies-backup-strategy-database">
<title>Database</title>
<para>MySQL backup either directly from a non-primary node in the galera
cluster (table dump locks the database during operation) or from a mysql slave
attached to the cluster.
</para>
</sect3>
<sect3 xml:id="_backup_strategy_backend_sources">
<sect3 xml:id="backup-backup-strategies-backup-strategy-backend-sources">
<title>Sources</title>
<para>The sources are supposed to be backup at the same time as the database. This
can get achieved by either having a dedicated instance for the source server
Expand All @@ -92,7 +92,7 @@
</listitem>
</itemizedlist>
</sect3>
<sect3 xml:id="_backup_strategy_backend_binaries">
<sect3 xml:id="backup-backup-strategies-backup-strategy-backend-binaries">
<title>Build Results</title>
<para>Full backups via snapshots, either offered by the SAN storage or
via LVM snapshot methods. Consistency is normally on repository level. Any inconsistency
Expand All @@ -103,13 +103,13 @@
</sect2>
</sect1>

<sect1 xml:id="_restore">
<sect1 xml:id="restore">
<title>Restore</title>
<para>
A restored system might contain inconsistencies if it was taken from a running service.
These can be resolved as follows.
</para>
<sect2 xml:id="_restore_database_inconsistencies">
<sect2 xml:id="restore-restore-database-inconsistencies">
<title>Check and repair database inconsistencies</title>
<para>If either database portions or sources got restored there are chances for inconsistencies.
These can be found via
Expand All @@ -128,7 +128,7 @@
<screen>&prompt.user;<command>cd /srv/www/obs/api/</command>
&prompt.user;<command>./bin/rake fix_project project="YOUR_PROJECT"</command> </screen>
</sect2>
<sect2 xml:id="_restore_binaries">
<sect2 xml:id="restore-restore-binaries">
<title>Binaries</title>
<para>All build results are evaluated by the scheduler. Therefore any inconsistency can be
detected by the scheduler. One way is to enforce a cold start, which means that the
Expand All @@ -151,7 +151,7 @@
</sect2>
</sect1>

<sect1 xml:id="_handle_data_corruption">
<sect1 xml:id="repair-data-corruption">
<title>Repair Data Corruption</title>
<para>
On-disk data might be corrupted independent of a restore. For example due to power outage, filesystem
Expand Down
8 changes: 4 additions & 4 deletions xml/obs_ag_build_targets.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
]>
<sect1 version="5.1" xml:id="_managing_build_targets"
<sect1 version="5.1" xml:id="managing-build-targets"
xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" >
<title>Managing Build Targets</title>
<sect2 xml:id="_interconnect">
<sect2 xml:id="managing-build-targets-interconnect">
<title>Interconnect</title>
<para>Using another Open Build Service as source for build targets is the
easiest way to start. The advantage is, that you save local resources and
Expand All @@ -26,7 +26,7 @@
create a remote project using the <emphasis>osc meta prj</emphasis> command.
A remote project differs from a local project as it has a <emphasis
role="strong">remoteurl</emphasis> tag (see <xref
linkend="_project_meta_data"/>).</para>
linkend="meta-data-project-meta-data"/>).</para>
<para>Example:</para>
<screen>&lt;project name="openSUSE.org"&gt;
&lt;title&gt;openSUSE.org Project Link&lt;/title&gt;
Expand All @@ -38,7 +38,7 @@ This project refers to projects hosted on the &osbs;
<para>Sending this via osc to the server:</para>
<screen>osc meta prj -m "add openSUSE.org remote" -F /tmp/openSUSE.org.prj</screen>
</sect2>
<sect2 xml:id="_importing_distributions">
<sect2 xml:id="managing-build-targets-importing-distributions">
<title>Importing Distributions</title>
<!-- do not describe old obs_mirror here anymore, it is misleading and broken -->
<para>FIXME: describe how to do it using DoD</para>
Expand Down
8 changes: 4 additions & 4 deletions xml/obs_ag_dispatch_priority.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
]>
<sect1 version="5.1" xml:id="_dispatch_priorities"
<sect1 version="5.1" xml:id="dispatch-priorities"
xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" >
Expand All @@ -20,9 +20,9 @@
><emphasis>/build/_dispatchprios</emphasis></emphasis><emphasis
role="strong">API</emphasis> call or via the <emphasis role="strong"
><emphasis>dispatch_adjust</emphasis></emphasis> array in the
<emphasis>BSConfig.pm</emphasis><xref linkend="_bsconfig_pm"/> configuration
<emphasis>BSConfig.pm</emphasis><xref linkend="bsconfig-pm"/> configuration
file.</para>
<sect2 xml:id="_build__dispatchprios_api_call">
<sect2 xml:id="dispatch-priorities-build-dispatchprios-api-call">
<title>The <literal>/build/_dispatchprios</literal> API Call</title>
<para>The <emphasis>/build/_dispatchprios</emphasis> API call allows an
Admin to set a priority for defined projects and repositories using the HTTP
Expand Down Expand Up @@ -224,7 +224,7 @@
</tgroup>
</table>
</sect2>
<sect2 xml:id="_dispatch_adjust_array">
<sect2 xml:id="dispatch-priorities-dispatch-adjust-array">
<title><literal>dispatch_adjust</literal> Array</title>
<para>With the <emphasis role="strong"
><emphasis>dispatch_adjust</emphasis></emphasis> array in the
Expand Down
Loading

0 comments on commit fb43e8a

Please sign in to comment.