doc/manual: Refactor, rewrite, improve and update most of the User Manual
* Some TODOs are added as comments which actually require code changes.
These are details which showed up as incongruences or missing bits
while writing the documentation for them.
* Some sections are introduced but still waiting to be writen soon:
** Debugging section
** Docker Setup section
** Ansible Setup section
** Troubleshooting (add jenkins red cross button sending kill -9)
** resources.conf attribute list needs to be converted to a table
* Device related setup needs to be updated and extended
* Parametrized scenarios need to be documented
* 4G resources documentation needs to be added.
Change-Id: Ifc2a3c74d45336cc988b76c0ff68a85311e4dd40
diff --git a/doc/manuals/osmo-gsm-tester-manual.adoc b/doc/manuals/osmo-gsm-tester-manual.adoc
index 6f0edf7..afee29b 100644
--- a/doc/manuals/osmo-gsm-tester-manual.adoc
+++ b/doc/manuals/osmo-gsm-tester-manual.adoc
@@ -1,20 +1,33 @@
-Osmo-GSM-Tester Manual
-======================
-Neels Hofmeyr <nhofmeyr@sysmocom.de>
+:app-name: Osmo-GSM-Tester
+
+{app-name} Manual
+=================
+Neels Hofmeyr <nhofmeyr@sysmocom.de>, Pau Espin Pedrol <pespin@sysmocom.de>
== WARNING: Work in Progress
-*NOTE: The osmo-gsm-tester is still in pre-alpha stage: some parts are still
-incomplete, and details will still change and move around.*
+*NOTE: {app-name} is still under heavy development stage: some parts are still
+incomplete, and details can still change and move around as new features are
+added and improvements made.*
include::{srcdir}/chapters/intro.adoc[]
-include::{srcdir}/chapters/install.adoc[]
+include::{srcdir}/chapters/trial.adoc[]
include::{srcdir}/chapters/config.adoc[]
-include::{srcdir}/chapters/trial.adoc[]
+include::{srcdir}/chapters/resource_pool.adoc[]
include::{srcdir}/chapters/test_api.adoc[]
+include::{srcdir}/chapters/install.adoc[]
+
+include::{srcdir}/chapters/install_device.adoc[]
+
+include::{srcdir}/chapters/ansible.adoc[]
+
+include::{srcdir}/chapters/docker.adoc[]
+
include::{srcdir}/chapters/debugging.adoc[]
+
+include::{srcdir}/chapters/troubleshooting.adoc[]