Rename folders

.github/workflows/do-not-edit.yml

@@ -5,18 +5,18 @@ on:
     branches-ignore:
       - main
     paths:
-      - 'ref/ams-configuration.md'
+      - 'reference/ams-configuration.md'
   pull_request:
     paths:
-      - 'ref/ams-configuration.md'
+      - 'reference/ams-configuration.md'
 
 jobs:
   check:
     name: Fail
     runs-on: ubuntu-latest
     steps:
       - name: Print error
-        run: echo "::error file=ref/ams-configuration.md::Never edit ref/ams-configuration.md manually - edit ref/ams-configuration.tmpl.md or ref/ams-configuration.yaml instead!"
+        run: echo "::error file=reference/ams-configuration.md::Never edit reference/ams-configuration.md manually - edit reference/ams-configuration.tmpl.md or reference/ams-configuration.yaml instead!"
 
       - name: Exit
         run: exit 1

.github/workflows/docs-links.yml

@@ -18,7 +18,7 @@
         with:
           files_ignore: |
             .github
-            release-notes
+            reference/release-notes
 
       - name: Find Anbox Cloud docs links
         id: find-anbox-cloud-docs-links
@@ -26,7 +26,7 @@
           awk '{
             # Use match explicitly to have access to retrieve column numbers
             # with RSTART and RLENGTH
             if (match($0, "anbox-cloud.io/docs") != 0)
               print "::error file="FILENAME\
                     ",line="FNR\
                     ",col="RSTART\

.github/workflows/generate.yml

@@ -3,12 +3,12 @@ name: Generate and commit AMS configuration doc
 on:
   push:
     paths:
-      - 'ref/ams-configuration.tmpl.md'
-      - 'ref/ams-configuration.yaml'
+      - 'reference/ams-configuration.tmpl.md'
+      - 'reference/ams-configuration.yaml'
   pull_request:
     paths:
-      - 'ref/ams-configuration.tmpl.md'
-      - 'ref/ams-configuration.yaml'
+      - 'reference/ams-configuration.tmpl.md'
+      - 'reference/ams-configuration.yaml'
 
 jobs:
   generate:
@@ -22,12 +22,12 @@ jobs:
         run: python scripts/generate-ams-config.py
 
       - name: Show Markdown file
-        run: cat ref/ams-configuration.md
+        run: cat reference/ams-configuration.md
 
       - name: Commit changes
         if: ${{ github.ref == 'refs/heads/main' }}
         uses: EndBug/add-and-commit@v9
         with:
           default_author: github_actions
           message: 'Generate AMS configuration doc'
-          add: 'ref/ams-configuration.md'
+          add: 'reference/ams-configuration.md'

ref/ams-http-api.md → reference/ams-http-api.md

@@ -1155,7 +1155,7 @@
       "images.version_lockstep": "true", // Prevent images of new minor releases to be pulled by AMS
       "registry.filter": "",             // (comma separated list) Filter out applications without matching tags
       "registry.fingerprint": <fingerprint>, // (string) Fingerprint of registry certificate
-      "registry.mode": "pull",           // (pull/push/manual) Whether AMS should act as a client or publisher automatically synchronizing applications with AAR, or manually doing so. Please refer to https://anbox-cloud.io/docs/exp/aar for all details.
+      "registry.mode": "pull",           // (pull/push/manual) Whether AMS should act as a client or publisher automatically synchronizing applications with AAR, or manually doing so. Please refer to https://anbox-cloud.io/docs/explanation/aar for all details.
       "registry.update_interval": "5s",  // (time) Frequency of updates from registry
       "registry.url": "https://127.0.0.1:3000", // (string) URL of Anbox Application Registry
       "scheduler.strategy": "spread"     // (spread|binpack) Container allocation schedule strategery
@@ -1272,7 +1272,7 @@
     "memory": 4294965097,                     # (number | optional) Number of bytes memory to be assigned for the container.
     "gpu_slots": 0,                           # (number | optional) Number of GPU slots to be allocated for the container to use
     "config": {                               # (struct | optional) Config parameters included in created container
         "platform": "null",                   # (string | optional) Platform name, optional value: "null", "swrast", "webrtc". Please refer to https://anbox-cloud.io/docs/reference/anbox-platforms for all details of each platform
         "boot_package": "com.my.app",         # (string | optional) Boot package
         "boot_activity": "com.my.app.Activity",   # (string | optional)  Boot acitivty
         "metrics_server": "influxdb:192.168.100.8:8095,raw",    # (string | optional) Metrics server
@@ -1285,7 +1285,7 @@
 ```json
 {
     "image_id": "Android_10",                 # (string | mandatory) Identifier or name of the application this container belongs to.
     "instance_type": "a4.3",                  # (string | mandatory)  Instance type to use for the container. Please refer to https://anbox-cloud.io/docs/manage/instance-types-reference for all available instance types.
     "image_version": 0,                       # (number | optional) Version of the image this container uses.
     "user_data": "",                          # (string | optional) Additional data to be put into the container when bootstrapped.
     "node": "lxd1",                           # (string | optional) Lxd node to use for the container to launch
@@ -1302,7 +1302,7 @@
     "memory": 4294965097,                     # (number | optional) Number of bytes memory to be assigned for the container.
     "gpu_slots": 0,                           # (number | optional) Number of GPU slots to be allocated for the container to use
     "config": {                               # (struct | optional) Config parameters included in created container
         "platform": "null",                    # (string | optional) Platform name, optional value: "null", "swrast", "webrtc". Please refer to https://anbox-cloud.io/docs/reference/anbox-platforms for all details of each platform
         "boot_package": "com.my.app",         # (string | optional) Boot package
         "boot_activity": "com.my.app.Activity",   # (string | optional)  Boot acitivty
         "metrics_server": "influxdb:192.168.100.8:8095,raw"    # (string | optional) Metrics server

release-notes/release-notes-template.md → reference/release-notes/release-notes-template.md

@@ -2,7 +2,7 @@
 
 The Anbox Cloud team is pleased to announce the release of Anbox Cloud < release-version >.
 
-Please see [component versions](https://anbox-cloud.io/docs/ref/component-versions) for a list of updated components.
+Please see [component versions](https://anbox-cloud.io/docs/reference/component-versions) for a list of updated components.
 
 ## New features & improvements
 

scripts/generate-ams-config.py

@@ -4,7 +4,7 @@
 
 tables = {}
 
-with open("ref/ams-configuration.yaml", 'r') as f:
+with open("reference/ams-configuration.yaml", 'r') as f:
 
     config = yaml.safe_load(f)
 
@@ -23,7 +23,7 @@
         tables[which] = table
 
 # Open the template file for reading and the Markdown file for writing
-with open("ref/ams-configuration.tmpl.md", 'r') as infile, open("ref/ams-configuration.md", 'w') as outfile:
+with open("reference/ams-configuration.tmpl.md", 'r') as infile, open("reference/ams-configuration.md", 'w') as outfile:
     outfile.write("<!-- DO NOT EDIT THIS FILE. IT IS GENERATED AUTOMATICALLY. -->\n")
     outfile.write("<!-- Edit ams-configuration.tmpl.md and ams-configuration.yaml instead. -->\n\n")
 

scripts/publish-pr.py

@@ -13,7 +13,7 @@
 
     for one in data:
         filename = one['filename']
-        if (filename == "ref/ams-configuration.yaml") or (filename == "ref/ams-configuration.tmpl.md"):
-            filename = "ref/ams-configuration.md"
+        if (filename == "reference/ams-configuration.yaml") or (filename == "reference/ams-configuration.tmpl.md"):
+            filename = "reference/ams-configuration.md"
         print("Publish "+filename)
         subprocess.call("./publish.sh "+filename, shell=True)