summaryrefslogtreecommitdiffstats
path: root/doc/website-v1/documentation.adoc
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 06:48:59 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 06:48:59 +0000
commitd835b2cae8abc71958b69362162e6a70c3d7ef63 (patch)
tree81052e3d2ce3e1bcda085f73d925e9d6257dec15 /doc/website-v1/documentation.adoc
parentInitial commit. (diff)
downloadcrmsh-upstream.tar.xz
crmsh-upstream.zip
Adding upstream version 4.6.0.upstream/4.6.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/website-v1/documentation.adoc')
-rw-r--r--doc/website-v1/documentation.adoc42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/website-v1/documentation.adoc b/doc/website-v1/documentation.adoc
new file mode 100644
index 0000000..dce5a0d
--- /dev/null
+++ b/doc/website-v1/documentation.adoc
@@ -0,0 +1,42 @@
+= Documentation =
+
+The main documentation for `crmsh` comes in the form of the
+`manual`, which is the same help as found using the `help`
+command in the interactive shell.
+
+Additionally, there are a couple of guides and other documents
+that will hopefully make using the shell as easy as possible.
+
+== Manual ==
+
+* link:/man[Manual (Development)]
+* link:/man-4.3[Manual (v4.3.x)]
+* link:/man-3[Manual (v3.x)]
+* link:/man-2.0[Manual (v2.x)]
+* link:/man-1.2[Manual (v1.2.x)]
+
+== Guides ==
+
+* link:/start-guide[Getting Started]
+* link:/history-guide[History Guide]
+* link:/rsctest-guide[Resource Testing Guide]
+* link:/configuration[Configuration]
+* link:/scripts[Cluster scripts]
+* link:/faq[Frequently Asked Questions]
+
+== Translations ==
+
+* https://blog.3ware.co.jp/2015/05/crmsh-getting-started/[Getting Started (Japanese)]
+
+== External documentation ==
+
+The SUSE
+https://www.suse.com/documentation/sle_ha/book_sleha/?page=/documentation/sle_ha/book_sleha/data/book_sleha.html[High
+Availability Guide] provides a guide to
+installing and configuring a complete cluster solution including both
+the `crm` shell and Hawk, the web GUI which uses the `crm` shell as
+its backend.
+
+For more information on Pacemaker in general, see the
+http://clusterlabs.org/doc/[Pacemaker documentation] at `clusterlabs.org`.
+