Skip to content

Commit dff7b32

Browse files
Simran-BpalashkarianerpaulamaxkernbachaMahanna
authored
DOC-761 | DOC-792 | Content split for (AI) Data Platform (#755)
* Experimental Platform split * WIP: Don't attempt to navigate to path but different version between Platform and Core docs * WIP: Navigation * Fix link * Test: Links between Platform and Core * Try to exclude aliases in link check * chore: update greens/reds * Hugo config: Temporarily disable aliases and exclude legacy versions * Preliminary support for versioned subfolders * Content re-organization and product renaming * Make core root folder not show cards for now * CircleCI: Increase time between config fetching attempts * WIP: New navigation scheme with inline version selector * chore: update logo, tweak colors * Theme: Add Urbanist font * Re-enable all core versions * Try Urbanist as font for headlines * CircleCI: Account for versions.yaml change when loading versions * Add optgroup to version selector with label "Version" * Set sans-serif as fallback font for headlines Less jarring change while the Urbanist font loads * Change tags due to renaming * Add EE tag tooltip for legacy content * Remove unnecessary tags * Move About ArangoDB out of versioned folder to ArangoDB top-level and move Features and Use cases under it * Add brand colors as CSS variables * Use Urbanist font for lead paragraph and card titles * Try electric lime as color for active nav items * Squashed commit of the following: commit e043896 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 23 12:53:43 2025 +0200 Move image, add View node option commit 49fbafa Merge: d6f3359 cdd39d5 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 23 10:13:04 2025 +0200 Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC-799 commit d6f3359 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 23 10:12:58 2025 +0200 Review feedback, mention that nodes, edges, and theming is remembered commit cdd39d5 Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 15:29:13 2025 +0200 Toolchain: Set go version for arangoproxy to 1.24.0 The trailing .0 unbreaks builds for Vadim commit 976bf21 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 15:25:16 2025 +0200 Vector index no longer experimental (#803) * Vector index no longer experimental * Rename startup option * Mention previous startup option name in release notes commit 311dee3 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 15:15:34 2025 +0200 DOC-816 | Deduced vertex collections from named graphs (#799) * Release notes * Fix typo * Remove mention of vertexCollections and add section about graph queries in cluster for path searches * Modify release notes example * Fix/unify examples commit c2609c7 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 15:07:29 2025 +0200 Vector indexes support filtering (#791) commit 4b7ab17 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 15:02:22 2025 +0200 Unexpected Content-Length headers or invalid URLs report errors instead of closing connections (#795) commit 57056a0 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:54:05 2025 +0200 DOC-805 | Extended memory accounting: COLLECT and MERGE() (#808) * Release notes for improved memory accounting: MERGE(), RETURN DISTINCT, and certain COLLECT operations * Mention already merged tracking features of internal buffers * Mention execution block tracking commit 7efadc3 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:22:40 2025 +0200 Release notes for @pid@ and @TEMP_BASE_DIR@ startup option placeholders (#790) commit 3a78aec Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:21:53 2025 +0200 RocksDB upgrade to 9.5.0 release notes (#710) * WIP: RocksDB upgrade to 9.5.0 release notes * Throttling wasn't changed * Apply to 3.13 * Clarify units * Some RocksDB startup option defaults have been reverted * Fix merge error * Fix merge mistake --------- Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> commit d596f51 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:13:31 2025 +0200 Sparse vector indexes (#770) * Vector index type now supports sparse option * Use same wording for sparse HTTP API docs, replace hash with persistent index, fix statements about estimates --------- Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> commit 3de2dbf Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:10:36 2025 +0200 Release notes about deprecation of --rocksdb.transaction-lock-timeout startup option (#762) Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> commit 73428ea Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:09:39 2025 +0200 DOC-776 | AQL query recording (#735) * AQL query recording API * Fix text about startup option, add more status codes * Rework release notes, adjust attribute names * Fix copy-paste mistake * Per Coordinator recording in clusters * fix merge error --------- Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> Co-authored-by: Paula <paula.mihu@arangodb.com> commit 85de2a3 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:08:47 2025 +0200 DOC-772 | `GEO_POINT()` accepts elevation but z coordinate is ignored in geo functions / validation of points in `GEO_MULTIPOINT()` and `GEO_(MULTI_)LINESTRING` (#733) * GEO_POINT() accepts elevation but z coordinate is ignored in geo functions * Add more details * Add introduced in 3.11 * Add release notes about point validation in AQL GeoJSON functions * Fix order --------- Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> commit 9cc6d81 Author: Simran <Simran-B@users.noreply.github.com> Date: Wed Oct 22 14:05:25 2025 +0200 DOC-765 | Cosine similarity fix for vector indexes (#719) * Initial reference docs about the vector index * HTTP API docs and refinements * Version remark, OpenAPI minItems/maxItems and fix a type * inBackground and parallelism are supported * Review feedback, address cosine metric issue, reword inBackground, add parallelism * Remove leftover line * Add internal links to release notes * Cosine similarity value out of range has been fixed * Add innerProduct metric --------- Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> commit 4f7090e Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 14:04:12 2025 +0200 Toolchain: Set lower 1.24 Go version as minimum for arangoproxy Go 1.25 is only available in alpine:edge at the moment commit 6594ebc Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 13:25:11 2025 +0200 Fix path for icon shortcode commit c12be47 Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 13:17:25 2025 +0200 Review feedback commit 14003ce Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 13:14:53 2025 +0200 Change icon shortcode image path commit 1fc696f Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 21 23:23:28 2025 +0200 Icons: Move settings icon to the canvas center commit 9b3b338 Author: Michele Rastelli <michele@arangodb.com> Date: Tue Oct 14 16:49:33 2025 +0200 updated ArangoDB Tinkerpop Provider limitations (#806) commit cc2db4d Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 16:13:52 2025 +0200 Fix edge styling options commit 4492cf6 Author: Michele Rastelli <michele@arangodb.com> Date: Tue Oct 14 15:53:54 2025 +0200 [DE-1040] ArangoDB Tinkerpop Provider: initial documentation (#750) * ArangoDB Tinkerpop Provider: initial documentation * fixed links * review * updated GraphFeatures * doc: gremlin console (DE-1062) * doc: gremlin server (DE-1061) * updated tinkerpop version to 3.7.4 * doc: fix complex id format * removed collection name prefix restriction * configurable label field name (DE-1070) * query optimizations * review; add content to all versions * keep vertex instead of node to align with tinkerpop concepts and terminology --------- Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> Co-authored-by: Paula <paula.mihu@arangodb.com> commit c38b58e Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 15:49:27 2025 +0200 Minor fixes commit f1600ef Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 15:36:28 2025 +0200 Update visual customization part commit 144f44d Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 15:36:02 2025 +0200 Extend README for icon shortcode commit 22d82c8 Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 11:37:39 2025 +0200 Rename icon files and mention icon shortcode to README commit 62860ef Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 11:00:24 2025 +0200 DOC-813 | Implement icon shortcode and add Graph Visualizer icons commit 0f718a1 Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 10:59:15 2025 +0200 Update descriptions commit 5ee3e0d Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 10:22:55 2025 +0200 Update customization screenshot commit 4d61a71 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 9 12:39:09 2025 +0200 Icon shortcode prototype commit c595f25 Merge: 155a71a 8a3c37d Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 9 10:27:01 2025 +0200 Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC-799 commit 155a71a Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 9 10:26:51 2025 +0200 Update Visualizer screenshots commit 8a3c37d Author: Paula Mihu <97217318+nerpaula@users.noreply.github.com> Date: Tue Oct 7 16:06:14 2025 +0200 OAS-11485 | Add warning regarding single server upgrade to cluster in ArangoGraph (#798) * add warning regarding single server upgrade to cluster * apply to 3.11 as well commit a570281 Author: Paula Mihu <97217318+nerpaula@users.noreply.github.com> Date: Tue Oct 7 16:03:49 2025 +0200 move gae content into genai chapter (#796) commit 1f925ce Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 2 09:55:57 2025 +0200 WIP * Unrelated consistency changes * Squashed commit of the following: commit f005cb3 Author: Paula <paula.mihu@arangodb.com> Date: Thu Oct 23 13:22:52 2025 +0200 fix broken links commit cb0629b Author: Paula <paula.mihu@arangodb.com> Date: Thu Oct 23 13:13:55 2025 +0200 remove tag for now commit 2474431 Author: Paula <paula.mihu@arangodb.com> Date: Wed Oct 22 19:29:42 2025 +0200 Renamed GenAI Suite to AI Services across all files, including endpoints; renamed Services folder to Reference; fix all broken links commit 80fb229 Author: Paula <paula.mihu@arangodb.com> Date: Thu Oct 16 10:27:08 2025 +0200 fix some broken links commit 52b1f2a Author: Paula <paula.mihu@arangodb.com> Date: Wed Oct 15 18:11:59 2025 +0200 reorganize genai suite overview pages commit f54dce1 Author: Paula <paula.mihu@arangodb.com> Date: Thu Oct 9 16:55:42 2025 +0200 added graphrag uses cases, reorganize content commit 50ea476 Author: Paula <paula.mihu@arangodb.com> Date: Wed Oct 15 17:10:38 2025 +0200 rework data platform content, make kubernetes more prominent commit 4249c4e Author: Paula <paula.mihu@arangodb.com> Date: Tue Oct 14 16:55:41 2025 +0200 rename ArangoDB Platform to Arango Data Platform commit abc5079 Author: Paula <paula.mihu@arangodb.com> Date: Tue Oct 14 16:50:32 2025 +0200 change menu titles * Update tag tooltips * Fix tab name in Graph Analytics * Graph Intelligence -> Graphs also in menu * ArangoGraph -> AMP in oasisctl generator * Change cloud banner alt text * Rename AI Services back to AI Suite Also fix oasisctl page and name capitalization * Squashed commit of the following: commit f15a592 Merge: e043896 4480ca8 Author: Simran <Simran-B@users.noreply.github.com> Date: Sat Oct 25 23:30:53 2025 +0200 Merge branch 'main' into DOC-799 commit e043896 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 23 12:53:43 2025 +0200 Move image, add View node option commit 49fbafa Merge: d6f3359 cdd39d5 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 23 10:13:04 2025 +0200 Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC-799 commit d6f3359 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 23 10:12:58 2025 +0200 Review feedback, mention that nodes, edges, and theming is remembered commit 6594ebc Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 13:25:11 2025 +0200 Fix path for icon shortcode commit c12be47 Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 13:17:25 2025 +0200 Review feedback commit 14003ce Author: Simran Spiller <simran@arangodb.com> Date: Wed Oct 22 13:14:53 2025 +0200 Change icon shortcode image path commit 1fc696f Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 21 23:23:28 2025 +0200 Icons: Move settings icon to the canvas center commit cc2db4d Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 16:13:52 2025 +0200 Fix edge styling options commit c38b58e Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 15:49:27 2025 +0200 Minor fixes commit f1600ef Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 15:36:28 2025 +0200 Update visual customization part commit 144f44d Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 15:36:02 2025 +0200 Extend README for icon shortcode commit 22d82c8 Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 11:37:39 2025 +0200 Rename icon files and mention icon shortcode to README commit 62860ef Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 11:00:24 2025 +0200 DOC-813 | Implement icon shortcode and add Graph Visualizer icons commit 0f718a1 Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 10:59:15 2025 +0200 Update descriptions commit 5ee3e0d Author: Simran Spiller <simran@arangodb.com> Date: Tue Oct 14 10:22:55 2025 +0200 Update customization screenshot commit 4d61a71 Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 9 12:39:09 2025 +0200 Icon shortcode prototype commit c595f25 Merge: 155a71a 8a3c37d Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 9 10:27:01 2025 +0200 Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC-799 commit 155a71a Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 9 10:26:51 2025 +0200 Update Visualizer screenshots commit 1f925ce Author: Simran Spiller <simran@arangodb.com> Date: Thu Oct 2 09:55:57 2025 +0200 WIP * New domain, Arango team/support * Whitespace control and typo * Simplify logic for in-development warning with a flag in versions.yaml * Fix and refactor breadcrumbs Make long version numbers for core work and switch from Microdata to RDFa * Set metadata for search engines noindex for deprecated and in-development versions, canonical link from stable version (e.g. 3.12) to stable alias * Toolchain: Adjust oasisctl generator for new docs structure and improve output * Move drivers & integrations under Ecosystem (#816) * rename data science adapters * Move 3.12 drivers and integrations under ecosystem, fix links * remove drivers and integrations from 3.13, add aliases * fix broken link due to double slash * fix more broken links * Revert links to drivers and integrations in 3.10 and 3.11 * Fix link * Fix driver headline * EOL support for Spark 3.3 --------- Co-authored-by: Simran Spiller <simran@arangodb.com> * Attribute-based theming (#821) * Docs homepage content (#819) * WIP: Docs homepage content Reuses the Graph to AI page * add avocado icons to product cards, remove old images * Adjust card CSS to float an icon to the right of the title * Rework homepage and ArangoDB introduction - New and reworked sections for From Graph to AI for a full journey - Move knowledge graph definition to GraphRAG - Remove outdated ArangoDB diagram from overview and mention self-managed cloud deployments - Use card shortcode icon parameter --------- Co-authored-by: Paula <paula.mihu@arangodb.com> Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> * Update Inkeep config * Toolchain: generate-oasisctl workflow no longer needs arangodb-X_XX (upstream references) * DOC-812 | New Query Editor & AQLizer feature page (#810) * Initial content about the new Query Editor * Describe how to work with/generate queries and adjust the viewport * Remembered/saved queries, product naming * Capitalize Query Editor, long page title * Add icons, update product name * Query management, AQLizer setup and feature overview * Remove Experimental tag * Add AQLizer to list of major AI Suite components * Add screenshot * AQLizer screenshot, hotkey, and Open in Editor button * Crop screenshot * Data Platform | Add dedicated K8s page and detailed descriptions (architecture/components) (#814) * data platform for amp is available upon request * Add new Kubernetes page; Add detailed descriptions of Data Platform's architecture and components * Apply suggestions from code review Co-authored-by: Simran <Simran-B@users.noreply.github.com> * apply review suggestions * Apply suggestion from @nerpaula * review * Fix link --------- Co-authored-by: Simran <Simran-B@users.noreply.github.com> Co-authored-by: Simran Spiller <simran@arangodb.com> * DOC-797 | Natural language to AQL service (txt2aql / AQLizer) (#794) * initial draft * add process-text-stream * add info box and placeholder for external endpoint URL * clarify provider-specific parameters, add OpenRouter, genai project no longer needed, add aqlizer mode * remove grpc (only internal use) * remove triton * apply review suggestions * apply suggestion Co-authored-by: maxkernbach <maximilian.kernbach@gmail.com> * Fix link * add missing https prefix in curl example URL --------- Co-authored-by: maxkernbach <maximilian.kernbach@gmail.com> Co-authored-by: Simran Spiller <simran@arangodb.com> * DOC-800 | New GraphRAG UI steps (#805) * new graphrag ui * finalize content, remove unnecessary screenshots, apply to all versions * update screenshot, fix typo * Fix image reference --------- Co-authored-by: Simran Spiller <simran@arangodb.com> * WIP: New navigation * Fix versioned submenu visibility * Fix active state for hard navigation and better expand widget * Replace versions in arangodb links on the client-side Hugo does not regenerate the content if it's mounted twice, so the links in /stable and /devel use /3.12 and /3.13 * Adjust cards on root page of 3.12 and 3.13 These pages are not accessble from the nav but via the breadcrumbs for instance. Should not be linked to. * Fix go to homepage * Rework mobile menu toggle Fix functionality, use event listener, remove unused CSS, fix references in JS * Fix version and error handling * Hide mobile navigation on click * Data Platform & AI Suite | October release notes (#824) * add release notes * Review --------- Co-authored-by: Simran Spiller <simran@arangodb.com> * DOC-815 | MCP Server (#820) * add initial content for MCP server * remove installation content and just link to docker hub * Leave the navigation closed by default on mobile * Restructuring and version for Data Platform (#823) * Data Platform is version 3 * Rename AQL > Graphs to AQL > Graph queries * Change Data Platform version to "v3.0" * Rename index-and-search -> indexes-and-search * Move arango-datasets to Ecosystem * Different admonitions for Data Platform and AI Suite * Rename 3.13 to 4.0 * Rename gen-ai.md service to ai-orchestrator.md * Don't link to version root page, don't change page when on ArangoDB root * Change menu title AMP API -> API * Update Graph Visualizer screenshot * DOC-790 | Importer & Retriever: Update startup parameters (#809) * update startup parameters * Apply suggestions from code review Co-authored-by: Anthony Mahanna <43019056+aMahanna@users.noreply.github.com> * apply changes to all versions, fix typo * instant and deep search * update description of instant and deep search; fix some anchor links * add missing description for chat_api_url * fix typo * reference project creation in retriever file; add project name validation rules * remove username from startup parameters * update startup parameters in genai service; add project_db_name in project creation; move and extend Projects * clarify project requirements; clarify OpenAI-compatible API usage * restructure and clarify all available search methods and executing queries * address review comments * update links --------- Co-authored-by: Anthony Mahanna <43019056+aMahanna@users.noreply.github.com> * Update tracking * Cleanup * Remove home.html to use regular list.html This adds the footer with the next link so that there is space at the bottom to avoid the content overlapping the Back to Top and Ask AI buttons * Tweak styling of nav scrollbar and version selector * Remove test links * Remove old aliases * Contribute link: Substitute version alias with version name to point to actual file on GitHub * Remove code that replaced the version in the URL with the selected one Also disable some logging * Align 3.10 and 3.11 structure with later versions (features, use cases, graph queries, indexes & search) and add aliases to avoid certain 404 pages when using the version switcher * DOC-811 | Update ArangoGraph screenshots to AMP (#828) * update arangograph screenshots (wip) * replace more images, remove unnecessary ones * remove all remaining arangograph images * remove arangograph ml image * remove arangographml image from ai-suite * Optimize PNGs with Bulk Squoosh --------- Co-authored-by: Simran Spiller <simran@arangodb.com> * Replace and remove links to arangodb.com --------- Co-authored-by: Palash Karia <2976363+palashkaria@users.noreply.github.com> Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com> Co-authored-by: Paula <paula.mihu@arangodb.com> Co-authored-by: maxkernbach <maximilian.kernbach@gmail.com> Co-authored-by: Anthony Mahanna <43019056+aMahanna@users.noreply.github.com>
1 parent 087a0f9 commit dff7b32

File tree

4,030 files changed

+323834
-345708
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,030 files changed

+323834
-345708
lines changed

.circleci/base_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ commands:
309309
fi
310310
311311
cd /home/circleci/project/docs-hugo/site
312-
git config user.email "simran@arangodb.com"
312+
git config user.email "simran@arango.ai"
313313
git config user.name "CircleCI Job"
314314
git add data/ content/
315315
git commit --allow-empty -m "[skip ci] Automatic commit of generated files from CircleCI"
@@ -602,7 +602,7 @@ workflows:
602602
when: { equal: [ release, << pipeline.parameters.workflow >> ] }
603603
jobs:
604604
- plain-build:
605-
url: https://docs.arangodb.com
605+
url: https://docs.arango.ai
606606
- deploy:
607607
deploy-args: "--prod"
608608
requires:

.circleci/config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ parameters:
4343
type: string
4444
default: "undefined"
4545

46-
arangodb-3_13:
46+
arangodb-4_0:
4747
type: string
4848
default: "undefined"
4949

@@ -87,7 +87,7 @@ jobs:
8787
command: |
8888
mkdir -p .circleci && cd .circleci
8989
fetched=false
90-
for i in $(seq 1 6); do
90+
for i in $(seq 1 5); do
9191
echo ""
9292
res=$(curl -fsS https://api.github.com/repos/arangodb/docs-hugo/contents/.circleci?ref=$CIRCLE_SHA1) || curlStatus=$?
9393
if [[ -z "${curlStatus:-}" ]]; then
@@ -103,7 +103,7 @@ jobs:
103103
fi
104104
unset curlStatus
105105
unset jqStatus
106-
sleep 10
106+
sleep 60
107107
done
108108
if [[ "$fetched" = false ]]; then
109109
echo "Failed to fetch download URLs"
@@ -116,7 +116,7 @@ jobs:
116116
117117
python3 generate_config.py \
118118
--workflow << pipeline.parameters.workflow >> \
119-
--arangodb-branches << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-3_13 >> \
119+
--arangodb-branches << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-4_0 >> \
120120
--arangodb-branch << pipeline.parameters.arangodb-branch >> \
121121
--release-type << pipeline.parameters.release-type >> \
122122
--docs-version << pipeline.parameters.docs-version >> \

.circleci/generate_config.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
## Load versions
2020
versions = yaml.safe_load(open("versions.yaml", "r"))
21-
versions = sorted(versions, key=lambda d: d['name'])
21+
versions = sorted(versions["/arangodb/"], key=lambda d: d['name'])
2222

2323

2424
print(f"Loaded versions {versions}")
@@ -389,7 +389,7 @@ def workflow_commit_generated_download_data(config):
389389
def workflow_release_launch_command(config):
390390
shell = "\
391391
export ENV=\"circleci\"\n \
392-
export HUGO_URL=https://docs.arangodb.com\n \
392+
export HUGO_URL=https://docs.arango.ai\n \
393393
export HUGO_ENV=release\n \
394394
export GENERATORS=''\n"
395395

CIRCLECI.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Invoke Args:
3030
### Deploy a plain build to production
3131

3232
To update the live documentation independently of an ArangoDB release, for
33-
example, because of changes to the ArangoGraph docs or to publish documentation
33+
example, because of changes to the Data Platform docs or to publish documentation
3434
improvements before the next ArangoDB release, follow the steps below.
3535

3636
1. Go to CircleCI and select the `docs-hugo` project.
@@ -48,7 +48,7 @@ improvements before the next ArangoDB release, follow the steps below.
4848
(The `release-type` is `docs` by default)
4949

5050
The docs-only release workflow runs a **plain build** of the documentation and
51-
deploys to production at <https://docs.arangodb.com> without approval step.
51+
deploys to production at <https://docs.arango.ai> without approval step.
5252

5353
## Example generation
5454

@@ -181,7 +181,7 @@ The ArangoDB release workflow includes the following jobs:
181181
- a release branch and pull request is created with the generated content, which
182182
needs to be reviewed and merged on GitHub
183183
- once merged, the workflow in CircleCI needs to be approved to start
184-
deploying to production at <https://docs.arangodb.com>
184+
deploying to production at <https://docs.arango.ai>
185185

186186
If any of the examples or generated content fails, the workflow fails as well.
187187
The build report can be found in the `generate-summary` check on GitHub.
@@ -219,9 +219,6 @@ Invoke Args:
219219
| Parameter type | Name | Value |
220220
|:---------------|:-----|:------|
221221
| string | `workflow` | `generate-oasisctl` |
222-
| string | `arangodb-3_10` | `arangodb/enterprise-preview:3.10-nightly` |
223-
| string | `arangodb-3_11` | `arangodb/enterprise-preview:3.11-nightly` |
224-
| string | `arangodb-3_12` | `arangodb/enterprise-preview:devel-nightly` |
225222
| string | `generators` | `oasisctl` |
226223
| boolean | `commit-generated` | `true` |
227224
| boolean | `create-pr` | `true` |

PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
- 3.10:
1010
- 3.11:
1111
- 3.12:
12-
- 3.13:
12+
- 4.0:

README.md

Lines changed: 60 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# ArangoDB Documentation
1+
# Arango Documentation
22

3-
This repository contains the source files of the ArangoDB documentation as
4-
published on [docs.arangodb.com](https://docs.arangodb.com/).
3+
This repository contains the source files of the Arango documentation as
4+
published on [docs.arango.ai](https://docs.arango.ai/).
55

6-
The ArangoDB documentation is licensed under Apache-2.0.
6+
The Arango documentation is licensed under Apache-2.0.
77
See [LICENSE](LICENSE) for details.
88

99
## Contribute
@@ -370,8 +370,8 @@ Inner shortcode
370370
Tags let you display badges, usually below a headline.
371371

372372
This is mainly used for pointing out if a feature is only available in the
373-
ArangoDB Platform, the ArangoGraph Insights Platform, or both.
374-
See [Environment remarks](#environment-remarks) for details.
373+
AI Suite, the Data Platform, the Arango Managed Platform (AMP), or multiple
374+
of them. See [Environment remarks](#environment-remarks) for details.
375375

376376
It is also used for [Edition remarks](#edition-remarks) in content before
377377
version 3.12.5.
@@ -432,13 +432,32 @@ Available attributes:
432432
- `class`: CSS classes to apply
433433
- `style`: CSS inline styles to apply
434434

435+
#### Icons
436+
437+
If a web interface uses icons, especially as buttons without labels, use
438+
the `icon` shortcode to inline an SVG file for a visual reference as
439+
demonstrated below:
440+
441+
```markdown
442+
Select all nodes ({{< icon "select-all" >}}), then right-click.
443+
```
444+
445+
Icons are supposed to supplement the text, i.e. not be embedded in sentences.
446+
They are hidden from screen readers.
447+
448+
To add new icons to the toolchain, save them to `site/content/images/icons/`.
449+
They are referenced by file name (without extension) in the shortcode.
450+
451+
SVG icon files should not define the attributes `width`, `height`, `aria-hidden`,
452+
and `focusable` on the `<svg>` tag.
453+
435454
#### Keyboard shortcuts
436455

437456
To document hotkeys and key combinations to press in a terminal or graphical
438457
user interface, use the `kbd` shortcode:
439458

440459
```markdown
441-
Hit {{< kbd "Ctrl Return" >}} respectively {{< kbd "Cmd Return" >}} to run the query.
460+
Press {{< kbd "Ctrl Return" >}} respectively {{< kbd "Cmd Return" >}} to run the query.
442461
```
443462

444463
#### Cards
@@ -529,8 +548,8 @@ The following shortcodes also exist but are rarely used:
529548
- Avoid overly long link labels, such as entire sentences.
530549

531550
- Use relative links for cross-references to other documentation pages, e.g.
532-
`../drivers/js/_index.md` instead of `/3.12/drivers/js/_index.md` or
533-
`https://docs.arangodb.com/3.12/drivers/js/`.
551+
`../../data-platform/_index.md` instead of `/data-platform/_index.md` or
552+
`https://docs.arango.ai/data-platform/`.
534553

535554
- Avoid **bold** and *italic* markup in headlines. If you have to use it, then
536555
prefer `**bold**` and `*italic*` over `__bold__` and `_italic_` because the
@@ -573,8 +592,10 @@ The following shortcodes also exist but are rarely used:
573592
- _DB-Server_, not ~~dbserver~~, ~~db-server~~, ~~DBserver~~ (unless it is a code value)
574593
- _Coordinator_ (uppercase C)
575594
- _Agent_, _Agency_ (uppercase A)
576-
- _ArangoGraph Insights Platform_ and _ArangoGraph_ for short, but not
577-
~~Oasis~~, ~~ArangoDB Oasis~~, or ~~ArangoDB Cloud~~
595+
- _Arango Managed Platform (AMP)_ and _AMP_ for short, but not
596+
~~Oasis~~, ~~ArangoDB Oasis~~, ~~ArangoDB Cloud~~, ~~ArangoGraph Insights Platform~~, or ~~ArangoGraph~~
597+
- _Arango Data Platform_, _Arango AI Data Platform_, and _AI Suite_, but not
598+
~~Arango AI Services Data Platform~~, ~~Arango AI Suite Data Platform~~, ~~AI Services~~, or ~~GenAI Suite~~
578599
- _Deployment mode_ (single server, cluster, etc.), not ~~deployment type~~
579600

580601
- Never capitalize the names of executables or code values, e.g. write
@@ -589,7 +610,7 @@ For external links, use standard Markdown. Clicking these links automatically
589610
opens them in a new tab:
590611

591612
```markdown
592-
[ArangoGraph Insights Platform](https://dashboard.arangodb.cloud)
613+
[Arango Managed Platform (AMP)](https://dashboard.arangodb.cloud)
593614
```
594615

595616
For internal links, use relative paths to the Markdown files. Always link to
@@ -677,25 +698,24 @@ deprecated features in the same manner with `Deprecated in: ...`.
677698
### Environment remarks
678699

679700
Pages and sections about features that are only available in certain environments
680-
such as the ArangoDB Platform, the ArangoGraph Insight Platform, or the
681-
ArangoDB Shell should indicate where they are available using the `tag` shortcode.
701+
such as in ArangoDB Shell should indicate where they are available using the
702+
`tag` shortcode.
682703

683-
In the unified Platform and ArangoGraph but not in the Core:
704+
Features exclusive to the Data Platform, AI Data Platform,
705+
Arango Managed Platform (AMP), and ArangoDB generally don't need to be tagged
706+
because they are in dedicated parts of the documentation. However, if there are
707+
subsections with different procedures, each can be tagged accordingly.
684708

685-
```markdown
686-
{{< tag "ArangoDB Platform" "ArangoGraph" >}}
687-
```
688-
689-
In the unified Platform only:
709+
In the AI Data Platform only:
690710

691711
```markdown
692-
{{< tag "ArangoDB Platform" >}}
712+
{{< tag "AI Data Platform" >}}
693713
```
694714

695-
In ArangoGraph only:
715+
In the Arango Managed Platform (AMP) only:
696716

697717
```markdown
698-
{{< tag "ArangoGraph" >}}
718+
{{< tag "AMP" >}}
699719
```
700720

701721
In the ArangoDB Shell but not the server-side JavaScript API:
@@ -722,7 +742,16 @@ Enterprise Edition features should indicate that the Enterprise Edition is
722742
required using a tag. Use the following include in the general case:
723743

724744
```markdown
725-
{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}}
745+
{{< tag "ArangoDB Enterprise Edition" "AMP" >}}
746+
```
747+
748+
### Experimental remark
749+
750+
Features that are available for testing but may still change or get removed and
751+
should thus not be used in production can be tagged as follows:
752+
753+
```markdown
754+
{{< tag "Experimental" >}}
726755
```
727756

728757
### Add lead paragraphs
@@ -760,8 +789,8 @@ Start off by finding a file name. It should be:
760789

761790
Note that the file name is independent of what will show in the navigation or
762791
what will be used as headline for that page. The file name will be used as
763-
part of the final URL, however. For example, `3.12/aql/examples.md` will become
764-
`http://docs.arangodb.com/3.12/aql/examples/`.
792+
part of the final URL, however. For example, `arangodb/3.12/aql/examples.md`
793+
will become `http://docs.arango.ai/arangodb/3.12/aql/examples/`.
765794

766795
Create a new file with the file name and a `.md` file extension. Open the file
767796
in a text editor (Visual Studio Code is recommended). Add the following
@@ -796,8 +825,9 @@ Otherwise, the following steps are necessary for moving content:
796825

797826
The URL of a page is derived from the file name and the parent folders, with
798827
special handling for sections (folders with a `_index.md` file).
799-
For example, `3.12/aql/operators.md` becomes the URL path `/3.12/aql/operators/`,
800-
and `3.12/aql/functions/_index.md` becomes `/3.12/aql/functions/`.
828+
For example, `arangodb/3.12/aql/operators.md` becomes the URL path
829+
`/arangodb/3.12/aql/operators/`, and `arangodb/3.12/aql/functions/_index.md`
830+
becomes `/arangodb/3.12/aql/functions/`.
801831

802832
If you rename a file, from `section/old-name.md` to `section/new-name.md` for
803833
instance, make sure to add a redirect for the old URL by adding the following to
@@ -869,7 +899,7 @@ in the ToC, whereas `<h4>`, `<h5>`, and `<h6>` will be ignored.
869899

870900
### Deprecate a version
871901

872-
When an ArangoDB version reaches [End-of-Life](https://www.arangodb.com/subscriptions/end-of-life-notice/),
902+
When an ArangoDB version reaches [End-of-Life](https://arango.ai/arangodb-product-support-end-of-life-announcements/),
873903
its documentation needs to be marked as such. For the respective version, set
874904
the `deprecated` attribute to `true` in the `site/data/versions.yaml` file:
875905

@@ -1236,7 +1266,7 @@ db._document("collection/does_not_exist"); // xpError(ERROR_ARANGO_DOCUMENT_NOT_
12361266
```
12371267

12381268
This will make the example generation continue despite the error. See
1239-
[Error codes and meanings](https://docs.arangodb.com/stable/develop/error-codes-and-meanings/)
1269+
[Error codes and meanings](https://docs.arango.ai/arangodb/stable/develop/error-codes/)
12401270
for a list of all error codes and their names. If a unexpected error is raised,
12411271
then the example generation will abort with an error.
12421272

0 commit comments

Comments
 (0)