OTA-2683: Migrate documentation platform

Adding Antora dir structure and updated
docs content.

Signed-off-by: Merlin Carter <merlin.carter@here.com>

.gitignore

@@ -45,3 +45,4 @@ __pycache__/
 
 # QT Creator
 CMakeLists.txt.user
+/docs/ota-client-guide/modules/ROOT/pages/_junk

docs/Doxyfile.in

@@ -799,7 +799,6 @@ INPUT                  = @CMAKE_SOURCE_DIR@/docs \
                          @CMAKE_SOURCE_DIR@/tests \
                          @CMAKE_SOURCE_DIR@/src/aktualizr_info \
                          @CMAKE_SOURCE_DIR@/src/aktualizr_primary \
-                         @CMAKE_SOURCE_DIR@/src/uptane_generator \
                          @CMAKE_SOURCE_DIR@/src/aktualizr_secondary \
                          @CMAKE_SOURCE_DIR@/src/cert_provider \
                          @CMAKE_SOURCE_DIR@/src/hmi_stub \
@@ -821,6 +820,7 @@ INPUT                  = @CMAKE_SOURCE_DIR@/docs \
                          @CMAKE_SOURCE_DIR@/src/libaktualizr/utilities \
                          @CMAKE_SOURCE_DIR@/src/load_tests \
                          @CMAKE_SOURCE_DIR@/src/sota_tools \
+                         @CMAKE_SOURCE_DIR@/src/uptane-generator \
                          @CMAKE_SOURCE_DIR@/CONTRIBUTING.md \
                          @CMAKE_SOURCE_DIR@/CHANGELOG.md
 

docs/README.adoc

@@ -1,34 +1,15 @@
-= Aktualizr reference docs
+= OTA Connect Developer Guide
 
-This directory contains developer-focused documentation on various specialized aktualizr topics.
+This directory contains the source of our **OTA Connect Developer Guide** which is published to our https://docs.ota.here.com[documentation portal].
 
-link:./client-provisioning-methods.adoc[client-provisioning-methods.adoc] - Describes how aktualizr handles provisioning with either shared credentials or device credentials. 
+You can also read the source files for this guide. To read this guide locally or in GitHub, start with the xref:ota-client-guide/modules/ROOT/nav.adoc[table of contents].
 
-link:./configuration.adoc[configuration.adoc] - A reference for aktualizr's TOML config files.
-
-link:./provisioning-methods-and-credentialszip.adoc[provisioning-methods-and-credentialszip.adoc] - An explanation of the format of credentials.zip, a bundle generated by HERE OTA Connect/OTA Community Edition containing necessary credentials and config for aktualizr and meta-updater.
-
-link:./deb-package-install.adoc[deb-package-install.adoc] - The https://github.com/advancedtelematic/aktualizr/releases[releases] page includes a .deb package for aktualizr. This isn't likely useful for most production use cases, but it can be handy for testing. This document guides you through how to use the .deb.
-
-link:./debugging-tips.adoc[debugging-tips.adoc] - Useful debugging info, mostly targeted at people contributing to the development of aktualizr.
-
-link:./fault-injection.adoc[fault-injection.adoc] - How to inject faults during aktualizr runs, to help test failure cases of the system.
-
-link:./provision-with-device-credentials.adoc[provision-with-device-credentials.adoc] - Provisioning with device credentials is a more secure way of provisioning devices. Unlike shared-credentials provisioning, each image is required to have some credentials side-loaded that are unique to the device which receives the image. This topic also explains of aktualizr's approach to using a hardware security module for provisioning with device credentials.
-
-link:./integrate-libaktualizr.adoc[integrate-libaktualizr.adoc] - How to use Aktualizr as a library ('libaktualizr') to implement custom software update clients. This can be used to integrate Aktualizr with a user interface or to deliver updates to a custom package manager.
-
-link:./linux-secondaries.adoc[linux-secondaries.adoc] - A quick how-to demonstrating aktualizr on a secondary ECU, using two QEMU devices.
-
-link:./rollback.adoc[rollback.adoc] - Developer documentation on how aktualizr, OSTree, and u-boot can be used to implement automatic rollback of a failed update.
-
-link:./schema-migrations.adoc[schema-migrations.adoc] - aktualizr uses a SQLite database for storing some config information and keys. This describes the steps needed for migrating the DB schema. Only useful for aktualizr developers.
-
-link:./security.adoc[security.adoc] - A brief description of properties a system running aktualizr must have to conform with the Uptane security model.
-
-link:./selectively-triggering-aktualizr.adoc[selectively-triggering-aktualizr.adoc] - Aktualizr normally runs as a service, polling for updates periodically. However, it can also be triggered externally--for example, in response to a shoulder-tap, or in response to user interaction on an HMI. This document describes how to do that.
+[NOTE]
+====
+Content includes, such as code snippets or reused text snippets will not render correctly in Github.
+====
 
-== Developer documentation
+== Reference documentation
 
 Additional documentation intended for developers that may need to use the libaktualizr API should refer to link:https://advancedtelematic.github.io/aktualizr/index.html[this doc]:
 [NOTE]
@@ -76,4 +57,4 @@ make doxygen
 1. In the second repo, make a directory for the tag or commit you wish to add, i.e. `mkdir 2018.63`.
 1. Copy the contents of `<build_dir>/docs/html` into the directory you just created. (Something like `cp -a <build_dir>/docs/html/* <second_repo>/2018.63`.)
 1. In the second repo, run `git add 2018.63`, `git commit -as`, and `git push`.
-1. Wait a minute or two for github to refresh and render the files.
+1. Wait a minute or two for github to refresh and render the files.

docs/client-provisioning-methods.adoc

@@ -0,0 +1 @@
+./ota-client-guide/modules/ROOT/pages/client-provisioning-methods.adoc