docs: consistent AsciiDoc headers, ToC

Add a table of contents to the documentation index page.

Consistently use '='-style headers. Remove the redundant
suffix from headers (== e.g. == -> == e.g.)

Signed-off-by: Jonathan Dowland <[email protected]>

Author: jmtd

docs/README.adoc

@@ -1,4 +1,5 @@
-# Red Hat UBI OpenJDK container images
+= Red Hat UBI OpenJDK container images
+:toc: right
 
 This is auto-generated documentation for the
 link:https://www.redhat.com/en/blog/introducing-red-hat-universal-base-image[Red

gendocs.sh

@@ -68,16 +68,16 @@ cp ./gendocs.py "$workdir/gendocs.py"
 cp ./docs/README.adoc "$workdir/README.adoc"
 
 # documentation for development branches
-addToIndex "\n== Development branches ==\n"
+addToIndex "\n== Development branches\n"
 for branch in ubi8 ubi9; do
-    addToIndex "\n=== $branch ===\n"
+    addToIndex "\n=== $branch\n"
     handleRef "$branch" "$branch"
 done
 
 # documentation for tagged releases
-addToIndex "\n== Released images =="
+addToIndex "\n== Released images"
 for tag in $(git tag -l 'ubi?-openjdk-containers*' | sort -r); do
-    addToIndex "\n=== $tag ===\n"
+    addToIndex "\n=== $tag\n"
     handleRef "$tag"
 done