Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions site/content/3.12/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ ArangoDB's Query Language AQL lets you use graphs, JSON documents, and search
via a single, composable query language.
{{% /card %}}

{{% card title="GenAI & Data Science" link="data-science/" %}}
{{% card title="GenAI & Data Science" link="../platform/data-science/" %}}
Discover the graph-powered machine learning and GraphRAG features of ArangoDB.
{{% /card %}}

{{% card title="ArangoDB Platform" link="components/platform/" %}}
{{% card title="ArangoDB Platform" link="../platform/" %}}
The ArangoDB Platform is the umbrella for hosting the entire ArangoDB offering
of products, including GraphML and GraphRAG.
{{% /card %}}
Expand Down
12 changes: 6 additions & 6 deletions site/content/3.12/about-arangodb/features/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >-
solution with a unified interface
---
For in-depth information about the ArangoDB Platform as a whole and how to
deploy and use it, see [The ArangoDB Platform](../../components/platform.md).
deploy and use it, see [The ArangoDB Platform](../../../platform/about-the-platform/_index.md).

## Architecture

Expand All @@ -34,24 +34,24 @@ deploy and use it, see [The ArangoDB Platform](../../components/platform.md).
- [**ArangoDB Core**](core.md): The ArangoDB database system with support for
graphs, documents, key-value, full-text search, and vector search.

- [**Graph Visualizer**](../../graphs/graph-visualizer.md):
- [**Graph Visualizer**](../../../platform/graph-intelligence/graph-visualizer.md):
A web-based tool for exploring your graph data with an intuitive interface and
sophisticated querying capabilities.

- [**Graph Analytics**](../../graphs/graph-analytics.md):
- [**Graph Analytics**](../../../platform/graph-intelligence/graph-analytics.md):
A service that can efficiently load graph data from the core database system
and run graph algorithms such as PageRank and many more.

- [**GenAI Suite**](../../data-science/_index.md):
- [**GenAI Suite**](../../../platform/data-science/_index.md):
ArangoDB's graph-powered machine learning (GraphML) as well as GraphRAG for
automatically building knowledge graphs from text and taking advantage of both
excerpts and higher-level summaries as context for turbocharging GenAI
applications.

- [**Notebook servers**](../../data-science/notebook-servers.md):
- [**Notebook servers**](../../../platform/data-science/notebook-servers.md):
Run Jupyter kernels in the Platform for hosting interactive, Python-based
notebooks to experiment and develop applications.

- [**MLflow integration**](../../data-science/graphrag/services/mlflow.md):
- [**MLflow integration**](../../../platform/data-science/graphrag/services/mlflow.md):
Use the popular MLflow for machine learning practitioners as part of the
ArangoDB Platform.
2 changes: 1 addition & 1 deletion site/content/3.12/aql/functions/vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To use vector search, you need to have vector embeddings stored in documents
and the attribute that stores them needs to be indexed by a
[vector index](../../index-and-search/indexing/working-with-indexes/vector-indexes.md).

You can calculate vector embeddings using [ArangoDB's GraphML](../../data-science/graphml/_index.md)
You can calculate vector embeddings using [ArangoDB's GraphML](../../../platform/data-science/graphml/_index.md)
capabilities (available in ArangoGraph) or using external tools.

{{< warning >}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/3.12/deploy/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ ArangoDB product offering with a unified interface in a Kubernetes cluster.
It is offered for self-hosting on-prem or in the cloud and as a managed service,
superseding the ArangoGraph Insights Platform.

See [The ArangoDB Platform](../components/platform.md) for details.
See [The ArangoDB Platform](../../platform/about-the-platform/_index.md) for details.

## How to deploy

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ startup option needs to be enabled on the deployment you want to restore to.
{{< /warning >}}

1. Enable the experimental vector index feature.
2. Calculate vector embeddings using [ArangoDB's GraphML](../../../data-science/graphml/_index.md)
2. Calculate vector embeddings using [ArangoDB's GraphML](../../../../platform/data-science/graphml/_index.md)
capabilities (available in ArangoGraph) or using external tools.
Store each vector as an attribute in the respective document.
3. Create a vector index over this attribute. You need to choose which
Expand Down
24 changes: 24 additions & 0 deletions site/content/platform/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Recommended Resources
menuTitle: 'Platform'
weight: 0
layout: default
---
{{< cloudbanner >}}

{{< cards >}}

{{% card title="What is the ArangoDB Platform?" link="about-the-platform/" %}}
The ArangoDB Platform is the umbrella for hosting the entire ArangoDB offering
of products, including GraphML and GraphRAG.
{{% /card %}}

{{% card title="Graph Intelligence" link="graph-intelligence/" %}}
Analyze and visualize your data with the Graph Analytics and Graph Visualizer features.
{{% /card %}}

{{% card title="GenAI & Data Science" link="data-science/" %}}
Discover the graph-powered machine learning and GraphRAG features of ArangoDB.
{{% /card %}}

{{< /cards >}}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: The ArangoDB Platform
menuTitle: Platform
weight: 169
weight: 5
description: >-
The ArangoDB Platform brings everything ArangoDB offers together to a single
solution that you can deploy on-prem or use as a managed service
Expand Down Expand Up @@ -65,7 +65,7 @@ of the platform features.
### Use the ArangoDB Platform as a managed service

The ArangoDB Platform is not available as a managed service yet, but it will
become available for the [ArangoGraph Insights Platform](../arangograph/_index.md)
become available for the [ArangoGraph Insights Platform](../../3.12/arangograph/_index.md)
in the future. Until then, you can request early access to the self-hosted
ArangoDB Platform for testing.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Generative Artificial Intelligence (GenAI) and Data Science
menuTitle: GenAI & Data Science
weight: 115
weight: 15
description: >-
ArangoDB's set of tools and technologies enables analytics, machine learning,
and GenAI applications powered by graph data
Expand Down Expand Up @@ -48,16 +48,16 @@ ArangoDB Platform web interface, guiding you through the process.

Alongside these components, you also get the following additional features:

- [**Graph Visualizer**](../graphs/graph-visualizer.md): A web-based tool for exploring your graph data with an
- [**Graph Visualizer**](../graph-intelligence/graph-visualizer.md): A web-based tool for exploring your graph data with an
intuitive interface and sophisticated querying capabilities.
- [**Jupyter notebooks**](notebook-servers.md): Run a Jupyter kernel in the platform for hosting
interactive notebooks for experimentation and development of applications
that use ArangoDB as their backend.
- **Public and private LLM support**: Use public LLMs such as OpenAI
or private LLMs with [Triton Inference Server](../data-science/graphrag/services/triton-inference-server.md).
- [**MLflow integration**](./graphrag/services/mlflow.md): Use the popular MLflow as a model registry for private LLMs
or private LLMs with [Triton Inference Server](graphrag/services/triton-inference-server.md).
- [**MLflow integration**](graphrag/services/mlflow.md): Use the popular MLflow as a model registry for private LLMs
or to run machine learning experiments as part of the ArangoDB Platform.
- [**Integrations**](./integrations/_index.md): Use ArangoDB together with cuGraph, NetworkX,
- [**Integrations**](integrations/_index.md): Use ArangoDB together with cuGraph, NetworkX,
and other data science tools.
- **Application Programming Interfaces**: Use the underlying APIs of the
GenAI Suite services and build your own integrations. See the
Expand All @@ -69,7 +69,7 @@ Alongside these components, you also get the following additional features:
The ArangoDB Platform includes the following features independent of the
GenAI Suite:

- [**Graph Analytics**](../graphs/graph-analytics.md): Run graph algorithms such as PageRank
- [**Graph Analytics**](../graph-intelligence/graph-analytics.md): Run graph algorithms such as PageRank
on dedicated compute resources.

## From graph to AI
Expand All @@ -92,7 +92,7 @@ Graph queries can answer questions like _**Who can introduce me to person X**_?

![Graph Query](../../images/graph-query.png)

See [Graphs in AQL](../aql/graphs/_index.md) for the supported graph queries.
See [Graphs in AQL](../../3.12/aql/graphs/_index.md) for the supported graph queries.

### Graph Analytics

Expand All @@ -106,7 +106,7 @@ Graph analytics can answer questions like _**Who are the most connected persons*
ArangoDB offers _Graph Analytics Engines_ to run algorithms such as
connected components, label propagation, and PageRank on your data. This feature
is available for the ArangoGraph Insights Platform. See
[Graph Analytics](../graphs/graph-analytics.md) for details.
[Graph Analytics](../graph-intelligence/graph-analytics.md) for details.

### GraphML

Expand Down Expand Up @@ -168,5 +168,5 @@ the following tasks:
## Sample datasets

If you want to try out ArangoDB's data science features, you may use the
[`arango-datasets` Python package](../components/tools/arango-datasets.md)
[`arango-datasets` Python package](../../3.12/components/tools/arango-datasets.md)
to load sample datasets into a deployment.
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ news sources, and locations are interconnected into a large graph.

![Example Event](../../../images/ArangoML_open_intelligence_visualization.png)

The [`arango-datasets`](../../components/tools/arango-datasets.md) Python package
The [`arango-datasets`](../../../3.12/components/tools/arango-datasets.md) Python package
allows you to load pre-defined datasets into ArangoDB Platform. It comes pre-installed in the
GraphML notebook environment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ curl -X POST https://<ExternalEndpoint>:8529/_open/auth \

This returns a JWT token that you can use as your Bearer token. For more
details about ArangoDB authentication and JWT tokens, see
the [ArangoDB Authentication](../../../develop/http-api/authentication/#jwt-user-tokens)
the [ArangoDB Authentication](../../../../3.12/develop/http-api/authentication/#jwt-user-tokens)
documentation.

## Complete Service lifecycle example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ curl -X POST https://<ExternalEndpoint>:8529/_open/auth \

This returns a JWT token that you can use as your Bearer token.
For more details about ArangoDB authentication and JWT tokens, see the
[ArangoDB Authentication](https://docs.arangodb.com/stable/develop/http-api/authentication/#jwt-user-tokens)
[ArangoDB Authentication](../../../../3.12/develop/http-api/authentication/#jwt-user-tokens)
documentation.

## Installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ pprint(importerResponse)
### Visualize and interact with the Knowledge Graph

Once the importer service has processed the document, you can visualize and
interact with the generated Knowledge Graph using the [Graph Visualizer](../../graphs/graph-visualizer.md)
interact with the generated Knowledge Graph using the [Graph Visualizer](../../graph-intelligence/graph-visualizer.md)
directly from the ArangoDB Platform web interface.

1. In the ArangoDB Platform web interface, select the database you have previously used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ You can only import a single file, either in `.md` or `.txt` format.
You can open and explore the Knowledge Graph that has been generated by clicking
on the **Explore in visualizer** button.

For more information, see the [Graph Visualizer](../../graphs/graph-visualizer.md) documentation.
For more information, see the [Graph Visualizer](../../graph-intelligence/graph-visualizer.md) documentation.

## Configure the Retriever service

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The notebooks are primarily focused on the following solutions:

The ArangoDB Notebooks include the following:
- Automatically connect to ArangoDB databases and GenAI platform services
- [Magic commands](../arangograph/notebooks.md#arangograph-magic-commands)
- [Magic commands](../../3.12/arangograph/notebooks.md#arangograph-magic-commands)
that simplify database interactions
- Example notebooks for learning

Expand Down
5 changes: 5 additions & 0 deletions site/content/platform/graph-intelligence/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Graph intelligence
menuTitle: Graph intelligence
weight: 10
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Graph Analytics
menuTitle: Graph Analytics
weight: 115
weight: 5
description: |
ArangoGraph offers Graph Analytics Engines to run graph algorithms on your
data separately from your ArangoDB deployments
Expand Down Expand Up @@ -64,22 +64,22 @@ Single server deployments using ArangoDB version 3.11 are not supported.

The [Management API](#management-api) for deploying and deleting engines requires
an ArangoGraph **API key**. See
[Generating an API Key](../arangograph/api/get-started.md#generating-an-api-key)
[Generating an API Key](../../3.12/arangograph/api/get-started.md#generating-an-api-key)
on how to create one.

You then need to generate an **access token** using the API key. See
[Authenticating with Oasisctl](../arangograph/api/get-started.md#authenticating-with-oasisctl)
[Authenticating with Oasisctl](../../3.12/arangograph/api/get-started.md#authenticating-with-oasisctl)
on how to do so using `oasisctl login`.

The [Engine API](#engine-api) uses one of two authentication methods, depending
on the [__auto login to database UI__](../arangograph/deployments/_index.md#auto-login-to-database-ui)
on the [__auto login to database UI__](../../3.12/arangograph/deployments/_index.md#auto-login-to-database-ui)
setting in ArangoGraph:
- **Enabled**: You can use an ArangoGraph access token created with an API key
(see above), allowing you to use one token for both the Management API and
the Engine API.
- **Disabled**: You need use a JWT user token created from ArangoDB credentials.
These session tokens need to be renewed every hour by default. See
[HTTP API Authentication](../develop/http-api/authentication.md#jwt-user-tokens)
[HTTP API Authentication](../../3.12/develop/http-api/authentication.md#jwt-user-tokens)
for details.

## Management API
Expand Down Expand Up @@ -246,7 +246,7 @@ Request and response payloads are JSON-encoded in the engine API.

Import graph data from a database of the ArangoDB deployment. You can import
named graphs as well as sets of vertex and edge collections (see
[Managed and unmanaged graphs](../graphs/_index.md#managed-and-unmanaged-graphs)).
[Managed and unmanaged graphs](../../3.12/graphs/_index.md#managed-and-unmanaged-graphs)).

```bash
curl -H "Authorization: bearer $ADB_TOKEN" -XPOST -d '{"database":"_system","graph_name":"connectedComponentsGraph"}' "$ENGINE_URL/v1/loaddata"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Graph Visualizer
menuTitle: Graph Visualizer
weight: 102
weight: 10
description: >-
Visually explore and interact with your ArangoDB graphs through an intuitive interface
---
Expand All @@ -24,7 +24,7 @@ create new nodes (vertices) and relations (edges).
{{< info >}}
Graph creation is **not** performed within the Graph Visualizer. Graphs must be
created in the **Management** section under **Graphs** of the second-level
navigation in the [web interface](../components/web-interface/graphs.md). Once
navigation in the [web interface](../../3.12/components/web-interface/graphs.md). Once
created, you can select a graph from the list for exploration and visualization.
{{< /info >}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: What's new in the ArangoDB Platform
menuTitle: ArangoDB Platform
weight: 5
menuTitle: Release notes
weight: 50
description: >-
Features and improvements in the ArangoDB Platform
---
Expand All @@ -20,7 +20,7 @@ of the core ArangoDB database system along with graph-powered machine learning
and GenAI capabilities as a single solution with a unified interface. Deploy the
Platform on-premise or in the cloud on top of Kubernetes.

To get started, see [Self-host the ArangoDB Platform](../components/platform.md#self-host-the-arangodb-platform).
To get started, see [Self-host the ArangoDB Platform](about-the-platform/_index.md#self-host-the-arangodb-platform).

### GenAI Suite

Expand All @@ -35,5 +35,5 @@ user-friendly interface seamlessly integrated into the ArangoDB Platform web int
- MLflow integration
- Graph Visualizer

To learn more, see the [GenAI Suite](../data-science/_index.md#genai-suite)
To learn more, see the [GenAI Suite](data-science/_index.md#genai-suite)
documentation.
5 changes: 5 additions & 0 deletions site/data/versions.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
- name: "platform"
version: "0.1.0"
alias: "platform"
deprecated: false

- name: "3.13"
version: "3.13.0"
alias: "devel"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
{{- $page.Store.Set "versionShort" $version.name }}
{{- $page.Store.Set "alias" $version.alias }}
{{- $page.Store.Set "deprecated" $version.deprecated }}
{{- template "checkVersionIsInDevelopment" dict "page" $page "pageVersion" $version.name "versions" $versions }}
{{- if ne $version.name "platform" }}
{{- template "checkVersionIsInDevelopment" dict "page" $page "pageVersion" $version.name "versions" $versions }}
{{- end }}
{{- end }}
{{- end }}

Expand Down
9 changes: 7 additions & 2 deletions site/themes/arangodb-docs-theme/static/js/theme.js
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,13 @@ function changeVersion() {
changeVersion();
}


var newUrl = window.location.pathname.replace(getVersionFromURL(), getVersionInfo(newVersion).alias) + window.location.hash;
var currentVersion = getVersionFromURL();
var newVersionAlias = getVersionInfo(newVersion).alias;
if (currentVersion == "platform" || newVersion == "platform") {
var newUrl = window.location.pathname = "/" + newVersionAlias + "/";
} else {
var newUrl = window.location.pathname.replace(currentVersion, newVersionAlias) + window.location.hash;
}
updateHistory(newUrl);
}

Expand Down
3 changes: 3 additions & 0 deletions toolchain/arangoproxy/internal/service/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,9 @@ func (service OpenapiService) ValidateOpenapiGlobalSpec() {
models.Logger.Summary("<h2>OPENAPI</h2>")

for _, version := range Versions {
if version.Name == "platform" {
continue
}
wg.Add(1)
go service.ValidateFile(version.Name, &wg)
}
Expand Down