Toolchain: Adjust oasisctl generator for new docs structure and improve output

Author: Simran-B

toolchain/scripts/generators/oasisctl.py

@@ -36,7 +36,8 @@
     'tandc': 'Terms & Conditions',
     'arangodb': 'ArangoDB',
     'cpusizes': 'CPU Sizes',
-    'nodesizes': 'Node Sizes'
+    'nodesizes': 'Node Sizes',
+    'scheduled-root-password-rotation': 'Scheduled Root Password Rotation'
 }
 
 
@@ -115,7 +116,12 @@ def create_filename(filename):
 def rewrite_content(data, section, filename, weight):
     title = ""
     content = ""
-    flags = {"inFrontMatter": False, "endFrontMatter": False, "inHeader": False, "firstHeaderContent": False}
+    flags = {
+        "inFrontMatter": False,
+        "endFrontMatter": False,
+        "inHeader": False,
+        "firstHeaderContent": False,
+    }
 
     for i, line in enumerate(data):
 
@@ -128,24 +134,24 @@ def rewrite_content(data, section, filename, weight):
 
         if flags["inFrontMatter"] and not flags["endFrontMatter"]:
             if line.startswith("description: "):
-                if filename.endswith("/options.md"):
-                    content = content + "description: Command-line client tool for managing the Arango Managed Platform (AMP)\n"
+                #if filename.endswith("/options.md"):
+                #    content = content + "description: Command-line client tool for managing AMP\n"
                 continue
 
             if line.startswith("layout: "):
                 continue
 
             if line.startswith("title: "):
                 if filename.endswith("/options.md"):
-                    content = content + f"title: Arango Managed Platform (AMP) Shell oasisctl\nmenuTitle: Options\nweight: {weight}\n"
+                    content = content + f"title: The `oasisctl` command\nmenuTitle: Options\nweight: {weight}\n"
                     continue
 
                 menuTitle = ""
                 title = line.rstrip().replace("title: ", "")
-                for word in title.split(" "):
+                for word in title.split(" ")[1:]:
                     menuTitle = menuTitle + f" {TITLE_CASE.get(word.lower(), word)}"
 
-                content = content + f"title:{menuTitle}\nmenuTitle:{menuTitle.replace('Oasisctl ', '')}\nweight: {weight}\n"
+                content = content + f"title:{menuTitle} with `oasisctl`\nmenuTitle:{menuTitle}\nweight: {weight}\n"
                 continue
 
         if line.startswith("###### Auto generated"):
@@ -169,7 +175,8 @@ def rewrite_content(data, section, filename, weight):
                 continue
 
             if line.startswith("## "):
-                content = content + line
+                # The command as a headline, e.g. ## oasisctl add group 
+                #content = content + line
                 continue
 
         if line == "---\n":

toolchain/scripts/toolchain.sh

@@ -114,6 +114,11 @@ function main() {
     process_server "$server"
   done
 
+  ## Independent of ArangoDB versions/servers
+  if [[ $GENERATORS == *"oasisctl"* ]]; then
+    generate_oasisctl
+  fi
+
   run_arangoproxy_and_site
 
   ## Start arangoproxy and site containers to build examples and site
@@ -434,10 +439,6 @@ function generators_from_source() {
   if [[ $GENERATORS == *"metrics"* ]]; then
     generate_metrics "$version"
   fi
-
-  if [[ $GENERATORS == *"oasisctl"* ]]; then
-    generate_oasisctl "$version"
-  fi
 }
 
 
@@ -575,8 +576,6 @@ function generate_metrics() {
 function generate_oasisctl() {
   echo "<li><strong>OasisCTL</strong>" >> /home/summary.md
 
-  version=$1
-
   log "[generate_oasisctl] Generate OasisCTL docs"
 
   if [ ! -f /tmp/oasisctl.zip ]; then
@@ -587,8 +586,8 @@ function generate_oasisctl() {
   mkdir -p /tmp/oasisctl
   mkdir -p /tmp/preserve
 
-  cp ../../site/content/$version/arangograph/oasisctl/_index.md /tmp/preserve/oasisctl.md > /dev/null
-  rm -r ../../site/content/$version/arangograph/oasisctl/* > /dev/null
+  cp ../../site/content/amp/oasisctl/_index.md /tmp/preserve/oasisctl.md > /dev/null
+  rm -r ../../site/content/amp/oasisctl/* > /dev/null
 
   log "[generate_oasisctl] oasisctl generate-docs --link-file-ext .html --replace-underscore-with - --output-dir /tmp/oasisctl)"
   res=$(oasisctl generate-docs --link-file-ext .html --replace-underscore-with - --output-dir /tmp/oasisctl)
@@ -597,14 +596,14 @@ function generate_oasisctl() {
     echo "<error code=8><strong> ERROR: </strong>$res</error>" >> /home/summary.md
   fi
 
-  log "[generate_oasisctl] "$PYTHON_EXECUTABLE" generators/oasisctl.py --src /tmp/oasisctl --dst ../../site/content/$version/arangograph/oasisctl/"
-  res=$(("$PYTHON_EXECUTABLE" generators/oasisctl.py --src /tmp/oasisctl --dst ../../site/content/$version/arangograph/oasisctl/) 2>&1 )
+  log "[generate_oasisctl] "$PYTHON_EXECUTABLE" generators/oasisctl.py --src /tmp/oasisctl --dst ../../site/content/amp/oasisctl/"
+  res=$(("$PYTHON_EXECUTABLE" generators/oasisctl.py --src /tmp/oasisctl --dst ../../site/content/amp/oasisctl/) 2>&1 )
   if [ $? -ne 0 ]; then
     log "[generate_oasisctl] [ERROR] Error from oasisctl.py: $res"
     echo "<error code=8><strong> ERROR: Error: </strong>$res</error></li>" >> /home/summary.md
   fi
 
-  cp /tmp/preserve/oasisctl.md ../../site/content/$version/arangograph/oasisctl/_index.md
+  cp /tmp/preserve/oasisctl.md ../../site/content/amp/oasisctl/_index.md
 
   echo "&#x2713;" >> /home/summary.md
   echo "</li>" >> /home/summary.md