Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add figure titles to make images easier to find #358

Merged
merged 2 commits into from
Nov 21, 2023
Merged

Add figure titles to make images easier to find #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8246e2a
Add figure titles to make images easier to find
tahliar Nov 17, 2023
272563b
Update xml/ha_resource_constraints.xml
tahliar Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions xml/article_pacemaker_remote.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,8 @@
between the cluster node and the remote node (see <xref
linkend="sec-ha-pmremote-install-phys-remote-nodes"/>).
</para>
<informalfigure>
<figure xml:id="fig-ha-pmremote-cluster-remote">
<title>Cluster with one remote node</title>
<mediaobject>
<imageobject>
<imagedata fileref="ha_pmremote-phys-remote-nodes.svg" width="45%"/>
Expand All @@ -140,7 +141,7 @@
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</listitem>
</varlistentry>
<varlistentry>
Expand All @@ -153,7 +154,8 @@
<option>remote-node</option> meta attribute (see
<xref linkend="sec-ha-pmremote-install-virt-guest-nodes"/>).
</para>
<informalfigure>
<figure xml:id="fig-ha-pmremote-cluster-guests">
<title>Cluster with guest nodes</title>
<mediaobject>
<imageobject>
<imagedata fileref="ha_pmremote-virt-guest-nodes.svg" width="65%"/>
Expand All @@ -166,7 +168,7 @@
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
<para>
For a physical machine that contains several guest nodes, the
process is as follows:
Expand Down
11 changes: 9 additions & 2 deletions xml/ha_acl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,16 +268,23 @@
As <guimenu>Xpath</guimenu>, enter the XPath expression
<literal>/cib</literal>.
</para>
<informalfigure>
<figure>
<title>&hawk2; Create Role</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-acl-role.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-acl-role.png" width="100%"/>
</imageobject>
<textobject role="description">
<phrase>
&hawk2;'s <literal>Create Role</literal> screen, showing where to
define rules for an ACL role.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
<step>
<para>
Expand Down
12 changes: 10 additions & 2 deletions xml/ha_configuring_resources.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1342,16 +1342,24 @@ hostname (string): Hostname
To see the attributes belonging to each proposed value, hover the mouse
pointer over the respective value.
</para>
<informalfigure>
<figure>
<title>Operation values</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-monitor-op.png" width="70%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-monitor-op.png" width="60%"/>
</imageobject>
<textobject role="description">
<phrase>
In the <literal>Operations</literal> list, beside the <literal>monitor</literal>
operation, hovering the mouse pointer over the number <literal>20</literal> shows
that this is the value for the <literal>timeout</literal> attribute.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
<step>
<para>
Expand Down
32 changes: 20 additions & 12 deletions xml/ha_hawk2_history_i.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,18 +115,22 @@
&hawk2; opens a new window and displays a table view of the latest
events.
</para>
<informalfigure>
<figure>
<title>Recent events table</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-node-events.png" width="100%"
/>
<imagedata fileref="hawk2-node-events.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-node-events.png" width="90%"
/>
<imagedata fileref="hawk2-node-events.png" width="90%"/>
</imageobject>
<textobject role="description">
<phrase>
A table showing the recent resource operations on node &node1;.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
</substeps>
</step>
Expand Down Expand Up @@ -265,18 +269,22 @@
click the report's name or select <guimenu>Show</guimenu> from the
<guimenu>Operations</guimenu> column.
</para>
<informalfigure>
<figure>
<title>&hawk2; report details</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-history-report-details.png" width="100%"
/>
<imagedata fileref="hawk2-history-report-details.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-history-report-details.png" width="90%"
/>
<imagedata fileref="hawk2-history-report-details.png" width="90%"/>
</imageobject>
<textobject role="description">
<phrase>
Report details, including the name, time frame, node events, and resource events.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
<step>
<para>
Expand Down
11 changes: 9 additions & 2 deletions xml/ha_hawk2_monitor_i.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,16 +196,23 @@
Enter the fully qualified host name of one of the nodes in the second
cluster. For example, <literal>&node3;</literal>.
</para>
<informalfigure>
<figure>
<title>&hawk2; add cluster details</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-dashboard-add-cluster.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-dashboard-add-cluster.png" width="100%"/>
</imageobject>
<textobject role="description">
<phrase>
The <literal>Add Cluster</literal> pop-up has fields for the cluster name,
the name of a node in the cluster, and the server port to connect to.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
<step>
<para>
Expand Down
11 changes: 9 additions & 2 deletions xml/ha_ocfs2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,16 +714,23 @@
The wizard displays the configuration snippet that will be applied to
the CIB and any additional changes, if required.
</para>
<informalfigure>
<figure>
<title>&hawk2; summary screen of &ocfs; CIB changes</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-wizard-ocfs2-verify.png" width="70%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-wizard-ocfs2-verify.png" width="70%"/>
</imageobject>
<textobject role="description">
<phrase>
A summary screen showing the changes to be applied to the CIB for
the &ocfs; resource.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
<step>
<para>
Expand Down
34 changes: 28 additions & 6 deletions xml/ha_resource_constraints.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -915,16 +915,24 @@
and enter a <guimenu>Value</guimenu> for the
<literal>failure-timeout</literal>.
</para>
<informalfigure>
<figure>
<title>&hawk2;: meta attributes for resource failover</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-failover-node.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-failover-node.png" width="100%"/>
</imageobject>
<textobject role="description">
<phrase>
&hawk2;'s <literal>Edit Primitive</literal> screen, showing where to add
and edit the meta attributes <literal>migration-threshold</literal> and
<literal>failure-timeout</literal>.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
<step>
<para>
Expand Down Expand Up @@ -1050,16 +1058,23 @@
Specify a value between <literal>-INFINITY</literal> and
<literal>INFINITY</literal> for <literal>resource-stickiness</literal>.
</para>
<informalfigure>
<figure>
<title>&hawk2;: meta attributes for resource failback</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-rsc-stickiness.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-rsc-stickiness.png" width="100%"/>
</imageobject>
<textobject role="description">
<phrase>
&hawk2;'s <literal>Edit Primitive</literal> screen, showing where to add
and edit the meta attribute <literal>resource-stickiness</literal>.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
</procedure>
</sect2>
Expand Down Expand Up @@ -1290,16 +1305,23 @@
In the empty text box next to the attribute, enter an attribute value. The
value must be an integer.
</para>
<informalfigure>
<figure>
<title>&hawk2;: edit node utilization attributes</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="hawk2-utilization-node.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="hawk2-utilization-node.png" width="100%"/>
</imageobject>
<textobject role="description">
<phrase>
&hawk2;'s <literal>Edit Node</literal> screen, showing where to add
and edit utilization attributes.
</phrase>
</textobject>
</mediaobject>
</informalfigure>
</figure>
</step>
<step>
<para>
Expand Down