Commit fd07c6b3 authored by Iustin Pop's avatar Iustin Pop

Some small doc updates

We change some formatting to sphinx-specific, to show how the
documentation can be improved.
Signed-off-by: default avatarIustin Pop <iustin@google.com>
Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
parent e2078d28
Ganeti administrator's guide
============================
Documents Ganeti version 2.0
Documents Ganeti version |version|
.. contents::
......@@ -173,8 +173,8 @@ Importing an instance is similar to creating a new one. The command is::
gnt-backup import -n TARGET_NODE -t DISK_TEMPLATE \
--src-node=NODE --src-dir=DIR INSTANCE_NAME
Most of the options available for the command *gnt-instance add* are
supported here too.
Most of the options available for the command :command:`gnt-instance
add` are supported here too.
High availability features
--------------------------
......@@ -262,6 +262,7 @@ you can deactivate them with the deactivate-disks command, which works
in the same way.
Accessing an instance's console
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The command to access a running instance's console is::
......@@ -281,8 +282,8 @@ command to ran to see a complete status for all your nodes is::
Cluster-wide debugging
~~~~~~~~~~~~~~~~~~~~~~
The *gnt-cluster* command offers several options to run tests or
execute cluster-wide operations. For example::
The :command:`gnt-cluster` command offers several options to run tests
or execute cluster-wide operations. For example::
gnt-cluster command
gnt-cluster copyfile
......@@ -291,4 +292,4 @@ execute cluster-wide operations. For example::
gnt-cluster getmaster
gnt-cluster version
See the man page *gnt-cluster* to know more about their usage.
See the man page :manpage:`gnt-cluster` to know more about their usage.
......@@ -1558,8 +1558,8 @@ DEBUG_LEVEL
These are only the basic variables we are thinking of now, but more
may come during the implementation and they will be documented in the
``ganeti-os-api`` man page. All these variables will be available to
all scripts.
:manpage:`ganeti-os-api` man page. All these variables will be
available to all scripts.
Some scripts will need a few more information to work. These will have
per-script variables, such as for example:
......
......@@ -223,7 +223,7 @@ nodes
No allocations should be made on nodes having either the ``drained``
or ``offline`` flags set. More details about these of node status
flags is available in the manpage *ganeti(7)*.
flags is available in the manpage :manpage:`ganeti(7)`.
Respone message
......
Ganeti installation tutorial
============================
Documents Ganeti version 2.0
Documents Ganeti version |version|
.. contents::
......@@ -450,7 +450,7 @@ installed.
apt-get install debootstrap dump kpartx
Alternatively, you can create your own OS definitions. See the manpage
*ganeti-os-interface*.
:manpage:`ganeti-os-interface`.
Initializing the cluster
++++++++++++++++++++++++
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment