TEST | OEM LTS version

.circleci/base_config.yml

@@ -28,7 +28,7 @@ commands:
 
             git clone --depth 1 --branch $branch_name --recurse-submodules --shallow-submodules --jobs 8 https://github.com/arangodb/arangodb.git /root/project
 
-            if [ "<< parameters.version >>" = "3.10" ] || [ "<< parameters.version >>" = "3.11" ]; then
+            if [ "<< parameters.version >>" = "3.10" ] || [ "<< parameters.version >>" = "3.11" || [ "<< parameters.version >>" = "oem" ]; then
                 ENTERPRISE_BRANCH="<< parameters.version >>"
             else
                 ENTERPRISE_BRANCH="devel"
@@ -131,7 +131,7 @@ commands:
             set +e
             if [ "<< parameters.version >>" = "3.10" ]; then
                 cmake --preset enterprise-pr -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -DCMAKE_EXE_LINKER_FLAGS="-fuse-ld=lld" -DCMAKE_LIBRARY_PATH=$OPENSSL_ROOT_DIR/lib -DUSE_MAINTAINER_MODE=Off -DUSE_GOOGLE_TESTS=Off -DUSE_FAILURE_TESTS=Off
-            elif [ "<< parameters.version >>" = "3.11" ]; then
+            elif [ "<< parameters.version >>" = "3.11" ] || [ "<< parameters.version >>" = "oem" ]; then
                 # The OpenSSL dir that CMake discovers needs to be adjacent to where ldap.h is located, here: /opt
                 cmake --preset enterprise-pr -DCMAKE_C_COMPILER=/tools/clang -DCMAKE_CXX_COMPILER=/tools/clang++ -DCMAKE_EXE_LINKER_FLAGS="-fuse-ld=lld" -DCMAKE_LIBRARY_PATH=$OPENSSL_ROOT_DIR/lib -DOPENSSL_ROOT_DIR=/opt -DUSE_MAINTAINER_MODE=Off -DUSE_GOOGLE_TESTS=Off -DUSE_FAILURE_TESTS=Off
             else
@@ -602,7 +602,7 @@ workflows:
     when: { equal: [ release, << pipeline.parameters.workflow >> ] }
     jobs:
       - plain-build:
-          url: https://docs.arangodb.com
+          url: https://docs.arango.ai
       - deploy:
           deploy-args: "--prod"
           requires:

.circleci/config.yml

@@ -31,6 +31,10 @@ parameters:
     type: string
     default: "undefined"
 
+  arangodb-oem:
+    type: string
+    default: "undefined"
+
   arangodb-3_10:
     type: string
     default: "undefined"
@@ -87,7 +91,7 @@ jobs:
           command: |
             mkdir -p .circleci && cd .circleci
             fetched=false
-            for i in $(seq 1 6); do
+            for i in $(seq 1 5); do
               echo ""
               res=$(curl -fsS https://api.github.com/repos/arangodb/docs-hugo/contents/.circleci?ref=$CIRCLE_SHA1) || curlStatus=$?
               if [[ -z "${curlStatus:-}" ]]; then
@@ -103,7 +107,7 @@ jobs:
               fi
               unset curlStatus
               unset jqStatus
-              sleep 10
+              sleep 60
             done
             if [[ "$fetched" = false ]]; then
               echo "Failed to fetch download URLs"
@@ -116,7 +120,7 @@ jobs:
 
             python3 generate_config.py \
               --workflow << pipeline.parameters.workflow >> \
-              --arangodb-branches << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-3_13 >> \
+              --arangodb-branches << pipeline.parameters.arangodb-oem >> << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-3_13 >> \
               --arangodb-branch << pipeline.parameters.arangodb-branch >> \
               --release-type << pipeline.parameters.release-type >> \
               --docs-version << pipeline.parameters.docs-version >> \

.circleci/generate_config.py

@@ -18,7 +18,7 @@
 
 ## Load versions
 versions = yaml.safe_load(open("versions.yaml", "r"))
-versions = sorted(versions, key=lambda d: d['name']) 
+versions = sorted(versions["/arangodb/"], key=lambda d: d['name']) 
 
 
 print(f"Loaded versions {versions}")
@@ -135,7 +135,7 @@ def workflow_generate(config):
                     }
                 })
 
-            if version in ["3.10", "3.11"]:
+            if version in ["3.10", "3.11", "oem"]:
                 if openssl.startswith("3.0"):
                     compileJob["compile-linux"]["build-image"] = "arangodb/build-alpine-x86_64:3.16-gcc11.2-openssl3.0.10"
                 elif openssl.startswith("3.1"):
@@ -191,7 +191,7 @@ def workflow_generate_scheduled(config):
             "compile-linux": {
                 "context": ["sccache-aws-bucket"],
                 "name": f"compile-{version}",
-                "arangodb-branch": f"arangodb/enterprise-preview:{version}-nightly" if version in ["3.10", "3.11"] else "arangodb/enterprise-preview:devel-nightly", # TODO: Any other 3.12.x image we could use?
+                "arangodb-branch": f"arangodb/enterprise-preview:{version}-nightly" if version in ["3.10", "3.11", "oem"] else "arangodb/enterprise-preview:devel-nightly", # TODO: Any other 3.12.x image we could use?
                 "version": version
             }
         }
@@ -241,14 +241,15 @@ def workflow_release_arangodb(config):
         }
     }
 
-    if args.docs_version in ["3.10", "3.11"]:
+    if args.docs_version in ["3.10", "3.11", "oem"]:
         if openssl.startswith("3.0"):
             compileJob["compile-linux"]["build-image"] = "arangodb/build-alpine-x86_64:3.16-gcc11.2-openssl3.0.10"
         elif openssl.startswith("3.1"):
             compileJob["compile-linux"]["build-image"] = "arangodb/build-alpine-x86_64:3.16-gcc11.2-openssl3.1.2"
         elif openssl.startswith("1.1"):
             compileJob["compile-linux"]["build-image"] = "arangodb/build-alpine-x86_64:3.16-gcc11.2-openssl1.1.1s"
         else:
+            # TODO: OEM might need a separate image
             compileJob["compile-linux"]["build-image"] = "arangodb/ubuntubuildarangodb-devel:9" # 3.11.13
     else: # build image for 3.12.4 and devel as of 2024-11-25
         compileJob["compile-linux"]["build-image"] = "arangodb/ubuntubuildarangodb-devel:9"
@@ -307,7 +308,7 @@ def workflow_generate_launch_command(config):
         branch = args.arangodb_branches[i]
 
         if args.workflow != "generate": #generate scheduled etc.
-            branch = f"arangodb/enterprise-preview:{version}-nightly" if version in ["3.10", "3.11"] else "arangodb/enterprise-preview:devel-nightly" # TODO: Any other 3.12.x image we could use?
+            branch = f"arangodb/enterprise-preview:{version}-nightly" if version in ["3.10", "3.11", "oem"] else "arangodb/enterprise-preview:devel-nightly" # TODO: Any other 3.12.x image we could use?
 
         if branch == "undefined":
             continue
@@ -389,7 +390,7 @@ def workflow_commit_generated_download_data(config):
 def workflow_release_launch_command(config):
     shell = "\
 export ENV=\"circleci\"\n \
-export HUGO_URL=https://docs.arangodb.com\n \
+export HUGO_URL=https://docs.arango.ai\n \
 export HUGO_ENV=release\n \
 export GENERATORS=''\n"
 

CIRCLECI.md

@@ -30,7 +30,7 @@ Invoke Args:
 ### Deploy a plain build to production
 
 To update the live documentation independently of an ArangoDB release, for
-example, because of changes to the ArangoGraph docs or to publish documentation
+example, because of changes to the Data Platform docs or to publish documentation
 improvements before the next ArangoDB release, follow the steps below.
 
 1. Go to CircleCI and select the `docs-hugo` project.
@@ -48,7 +48,7 @@ improvements before the next ArangoDB release, follow the steps below.
 (The `release-type` is `docs` by default)
 
 The docs-only release workflow runs a **plain build** of the documentation and
-deploys to production at <https://docs.arangodb.com> without approval step.
+deploys to production at <https://docs.arango.ai> without approval step.
 
 ## Example generation
 
@@ -75,6 +75,7 @@ arguments are invoked:
 | Parameter type | Name | Value |
 |:---------------|:-----|:------|
 | string | `workflow` | `generate` |
+| string | `arangodb-oem` | [Upstream reference](#upstream-references) for OEM LTS |
 | string | `arangodb-3_10` | [Upstream reference](#upstream-references) for 3.10 |
 | string | `arangodb-3_11` | [Upstream reference](#upstream-references) for 3.11 |
 | string | `arangodb-3_12` | [Upstream reference](#upstream-references) for 3.12 |
@@ -93,6 +94,7 @@ arguments are invoked:
 | Parameter type | Name | Value |
 |:---------------|:-----|:------|
 | string | `workflow` | `generate` |
+| string | `arangodb-oem` | [Upstream reference](#upstream-references) for OEM LTS |
 | string | `arangodb-3_10` | [Upstream reference](#upstream-references) for 3.10 |
 | string | `arangodb-3_11` | [Upstream reference](#upstream-references) for 3.11 |
 | string | `arangodb-3_12` | [Upstream reference](#upstream-references) for 3.12 |
@@ -121,6 +123,7 @@ or for multiple versions.
 | Parameter type | Name | Value |
 |:---------------|:-----|:------|
 | string | `workflow` | `generate` |
+| string | `arangodb-oem` | [Upstream reference](#upstream-references) for OEM LTS |
 | string | `arangodb-3_10` | [Upstream reference](#upstream-references) for 3.10 |
 | string | `arangodb-3_11` | [Upstream reference](#upstream-references) for 3.11 |
 | string | `arangodb-3_12` | [Upstream reference](#upstream-references) for 3.12 |
@@ -181,7 +184,7 @@ The ArangoDB release workflow includes the following jobs:
 - a release branch and pull request is created with the generated content, which
   needs to be reviewed and merged on GitHub
 - once merged, the workflow in CircleCI needs to be approved to start
-  deploying to production at <https://docs.arangodb.com>
+  deploying to production at <https://docs.arango.ai>
 
 If any of the examples or generated content fails, the workflow fails as well.
 The build report can be found in the `generate-summary` check on GitHub.
@@ -202,6 +205,7 @@ Invoke Args:
 | Parameter type | Name | Value |
 |:---------------|:-----|:------|
 | string | `workflow` | `generate-scheduled` |
+| string | `arangodb-oem` | `arangodb/enterprise-preview:oem-nightly` |
 | string | `arangodb-3_10` | `arangodb/enterprise-preview:3.10-nightly` |
 | string | `arangodb-3_11` | `arangodb/enterprise-preview:3.11-nightly` |
 | string | `arangodb-3_12` | `arangodb/enterprise-preview:devel-nightly` |
@@ -219,6 +223,7 @@ Invoke Args:
 | Parameter type | Name | Value |
 |:---------------|:-----|:------|
 | string | `workflow` | `generate-oasisctl` |
+| string | `arangodb-oem` | `arangodb/enterprise-preview:oem-nightly` |
 | string | `arangodb-3_10` | `arangodb/enterprise-preview:3.10-nightly` |
 | string | `arangodb-3_11` | `arangodb/enterprise-preview:3.11-nightly` |
 | string | `arangodb-3_12` | `arangodb/enterprise-preview:devel-nightly` |

README.md

@@ -1,9 +1,9 @@
-# ArangoDB Documentation
+# Arango Documentation
 
-This repository contains the source files of the ArangoDB documentation as
-published on [docs.arangodb.com](https://docs.arangodb.com/).
+This repository contains the source files of the Arango documentation as
+published on [docs.arango.ai](https://docs.arango.ai/).
 
-The ArangoDB documentation is licensed under Apache-2.0.
+The Arango documentation is licensed under Apache-2.0.
 See [LICENSE](LICENSE) for details.
 
 ## Contribute
@@ -276,7 +276,7 @@ requiring to manually apply changes to different versions as necessary.
   - `public/` - Default output directory for the generated site (not committed)
   - `resources/` - Holds the various cached resources that are generated by Hugo
     when using `hugo serve`
-  - `themes/` - Folder for Hugo themes, containing the customized ArangoDB docs theme
+  - `themes/` - Folder for Hugo themes, containing the customized Arango docs theme
 - `toolchain/` - Folder for the docs toolchain tools and scripts
   - `arangoproxy/` - Source code of the arangoproxy web server
   - `docker/` - The Docker container and compose files, with two sets of
@@ -367,8 +367,8 @@ Inner shortcode
 Tags let you display badges, usually below a headline.
 
 This is mainly used for pointing out if a feature is only available in the
-ArangoDB Platform, the ArangoGraph Insights Platform, or both.
-See [Environment remarks](#environment-remarks) for details.
+AI Suite, the Data Platform, the Arango Managed Platform (AMP), or multiple
+of them. See [Environment remarks](#environment-remarks) for details.
 
 It is also used for [Edition remarks](#edition-remarks) in content before
 version 3.12.5.
@@ -429,6 +429,25 @@ Available attributes:
 - `class`: CSS classes to apply
 - `style`: CSS inline styles to apply
 
+#### Icons
+
+If a web interface uses icons, especially as buttons without labels, use
+the `icon` shortcode to inline an SVG file for a visual reference as
+demonstrated below:
+
+```markdown
+Select all nodes ({{< icon "select-all" >}}), then right-click.
+```
+
+Icons are supposed to supplement the text, i.e. not be embedded in sentences.
+They are hidden from screen readers.
+
+To add new icons to the toolchain, save them to `site/content/images/icons/`.
+They are referenced by file name (without extension) in the shortcode.
+
+SVG icon files should not define the attributes `width`, `height`, `aria-hidden`,
+and `focusable` on the `<svg>` tag.
+
 #### Keyboard shortcuts
 
 To document hotkeys and key combinations to press in a terminal or graphical
@@ -526,8 +545,8 @@ The following shortcodes also exist but are rarely used:
 - Avoid overly long link labels, such as entire sentences.
 
 - Use relative links for cross-references to other documentation pages, e.g.
-  `../drivers/js/_index.md` instead of `/3.12/drivers/js/_index.md` or
-  `https://docs.arangodb.com/3.12/drivers/js/`.
+  `../../data-platform/_index.md` instead of `/data-platform/_index.md` or
+  `https://docs.arango.ai/data-platform/`.
 
 - Avoid **bold** and *italic* markup in headlines. If you have to use it, then
   prefer `**bold**` and `*italic*`  over `__bold__` and `_italic_` because the
@@ -570,8 +589,10 @@ The following shortcodes also exist but are rarely used:
   - _DB-Server_, not ~~dbserver~~, ~~db-server~~, ~~DBserver~~ (unless it is a code value)
   - _Coordinator_ (uppercase C)
   - _Agent_, _Agency_ (uppercase A)
-  - _ArangoGraph Insights Platform_ and _ArangoGraph_ for short, but not
-    ~~Oasis~~, ~~ArangoDB Oasis~~, or ~~ArangoDB Cloud~~
+  - _Arango Managed Platform (AMP)_ and _AMP_ for short, but not
+    ~~Oasis~~, ~~ArangoDB Oasis~~, ~~ArangoDB Cloud~~, ~~ArangoGraph Insights Platform~~, or ~~ArangoGraph~~
+  - _Arango Data Platform_, _Arango AI Data Platform_, and _AI Suite_, but not
+    ~~Arango AI Services Data Platform~~, ~~Arango AI Suite Data Platform~~, ~~AI Services~~, or ~~GenAI Suite~~
   - _Deployment mode_ (single server, cluster, etc.), not ~~deployment type~~
 
 - Never capitalize the names of executables or code values, e.g. write
@@ -586,7 +607,7 @@ For external links, use standard Markdown. Clicking these links automatically
 opens them in a new tab:
 
 ```markdown
-[ArangoGraph Insights Platform](https://dashboard.arangodb.cloud)
+[Arango Managed Platform (AMP)](https://dashboard.arangodb.cloud)
 ```
 
 For internal links, use relative paths to the Markdown files. Always link to
@@ -674,25 +695,24 @@ deprecated features in the same manner with `Deprecated in: ...`.
 ### Environment remarks
 
 Pages and sections about features that are only available in certain environments
-such as the ArangoDB Platform, the ArangoGraph Insight Platform, or the
-ArangoDB Shell should indicate where they are available using the `tag` shortcode.
+such as in ArangoDB Shell should indicate where they are available using the
+`tag` shortcode.
 
-In the unified Platform and ArangoGraph but not in the Core:
+Features exclusive to the Data Platform, AI Data Platform,
+Arango Managed Platform (AMP), and ArangoDB generally don't need to be tagged
+because they are in dedicated parts of the documentation. However, if there are
+subsections with different procedures, each can be tagged accordingly.
 
-```markdown
-{{< tag "ArangoDB Platform" "ArangoGraph" >}}
-```
-
-In the unified Platform only:
+In the AI Data Platform only:
 
 ```markdown
-{{< tag "ArangoDB Platform" >}}
+{{< tag "AI Data Platform" >}}
 ```
 
-In ArangoGraph only:
+In the Arango Managed Platform (AMP) only:
 
 ```markdown
-{{< tag "ArangoGraph" >}}
+{{< tag "AMP" >}}
 ```
 
 In the ArangoDB Shell but not the server-side JavaScript API:
@@ -719,7 +739,16 @@ Enterprise Edition features should indicate that the Enterprise Edition is
 required using a tag. Use the following include in the general case:
 
 ```markdown
-{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}}
+{{< tag "ArangoDB Enterprise Edition" "AMP" >}}
+```
+
+### Experimental remark
+
+Features that are available for testing but may still change or get removed and
+should thus not be used in production can be tagged as follows:
+
+```markdown
+{{< tag "Experimental" >}}
 ```
 
 ### Add lead paragraphs
@@ -757,8 +786,8 @@ Start off by finding a file name. It should be:
 
 Note that the file name is independent of what will show in the navigation or
 what will be used as headline for that page. The file name will be used as
-part of the final URL, however. For example, `3.12/aql/examples.md` will become
-`http://docs.arangodb.com/3.12/aql/examples/`.
+part of the final URL, however. For example, `arangodb/3.12/aql/examples.md`
+will become `http://docs.arango.ai/arangodb/3.12/aql/examples/`.
 
 Create a new file with the file name and a `.md` file extension. Open the file
 in a text editor (Visual Studio Code is recommended). Add the following
@@ -793,8 +822,9 @@ Otherwise, the following steps are necessary for moving content:
 
 The URL of a page is derived from the file name and the parent folders, with
 special handling for sections (folders with a `_index.md` file).
-For example, `3.12/aql/operators.md` becomes the URL path `/3.12/aql/operators/`,
-and `3.12/aql/functions/_index.md` becomes `/3.12/aql/functions/`.
+For example, `arangodb/3.12/aql/operators.md` becomes the URL path
+`/arangodb/3.12/aql/operators/`, and `arangodb/3.12/aql/functions/_index.md`
+becomes `/arangodb/3.12/aql/functions/`.
 
 If you rename a file, from `section/old-name.md` to `section/new-name.md` for
 instance, make sure to add a redirect for the old URL by adding the following to
@@ -1233,7 +1263,7 @@ db._document("collection/does_not_exist"); // xpError(ERROR_ARANGO_DOCUMENT_NOT_
 ```
 
 This will make the example generation continue despite the error. See
-[Error codes and meanings](https://docs.arangodb.com/stable/develop/error-codes-and-meanings/)
+[Error codes and meanings](https://docs.arango.ai/arangodb/stable/develop/error-codes/)
 for a list of all error codes and their names. If a unexpected error is raised,
 then the example generation will abort with an error.