Add doc support and other CI related files
This change adds verious bits needed for CI and/or documentation
scraping as well as some README files.
The version in the CMake file was set to 0.1.0 in prep for activation
of CI jobs -- we want to be able to fiddle with those without actually
pushing a 1.x.x package to the repo. Once CI jobs are working we can
up the version to 1.0.0 to match the AP version.
Issue-ID: RIC-684
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: Iac2c24a8e8f1c01af74e20c0bce9cad1c6bf6702
diff --git a/CONTENTS b/CONTENTS
new file mode 100644
index 0000000..5d1ff39
--- /dev/null
+++ b/CONTENTS
@@ -0,0 +1,34 @@
+This directory contains files which may seem (and probably are)
+out of place in the root. Mostly these are CI files which should
+really be placed into a CI directory, but must exist here else
+the CI mechanics fall over. This is a list of these odd files.
+
+
+docs -- This directory contains generated documentation that is
+ scraped and placed on an external documentation site. The directory
+ name must be exactly "doc" and the CI/doc jobs fail if there
+ are files in the directory which are not referenced by the
+ index.
+
+rmr-version.yaml The CI vetting processes create environments
+ which include the RMR libraries. This file contains a single
+ definition of the desired RMR version to use in these
+ environments. There should be no need for RMR in any of
+ the evironments used to vet this code, so the version here
+ just needs to reference something available.
+
+tox.ini -- It is unclear exactly what this is for given that
+ there is no python code associated with this repo. The only
+ guess is that the document scraper/verification CI job is
+ a python application and requires this.
+
+.readthedocs.yaml -- Another doc CI configuration bit of goop.
+
+releases -- This is a directory which contains a single yaml file
+ used to indicate to the CI jobs which library should be moved
+ from the package cloud staging repo to the release repo. See
+ the README in that directory for more details.
+
+
+The rest of the files, like .git* should be well known to developers
+and thus are not explained here.