Skip to content

Commit d860123

Browse files
josh-wongjosh-wong
authored
Add notice about the relocation of docs (#252)
[skip ci]
1 parent 7d34c52 commit d860123

34 files changed

+306
-0
lines changed

‎docs/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Index
211

312
## For users

‎docs/ReleaseFlow.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Release Flow
211

312
## Requirements

‎docs/configure-custom-values-envoy.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for Scalar Envoy
211

312
This document explains how to create your custom values file for the Scalar Envoy chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/envoy/README.md) of the Scalar Envoy chart.

‎docs/configure-custom-values-file.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for Scalar Helm Charts
211

312
When you deploy Scalar products using Scalar Helm Charts, you must prepare your custom values file based on your environment. Please refer to the following documents for more details on how to a create custom values file for each product.

‎docs/configure-custom-values-scalar-admin-for-kubernetes.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for Scalar Admin for Kubernetes
211

312
This document explains how to create your custom values file for the Scalar Admin for Kubernetes chart. For details on the parameters, see the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-admin-for-kubernetes/README.md) of the Scalar Admin for Kubernetes chart.

‎docs/configure-custom-values-scalar-manager.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for Scalar Manager
211

312
This document explains how to create your custom values file for the Scalar Manager chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-manager/README.md) of the Scalar Manager chart.

‎docs/configure-custom-values-scalardb-analytics-postgresql.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for ScalarDB Analytics with PostgreSQL
211

312
This document explains how to create your custom values file for the ScalarDB Analytics with PostgreSQL chart. For details on the parameters, see the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb-analytics-postgresql/README.md) of the ScalarDB Analytics with PostgreSQL chart.

‎docs/configure-custom-values-scalardb-cluster.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for ScalarDB Cluster
211

312
This document explains how to create your custom values file for the ScalarDB Cluster chart. For details on the parameters, see the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb-cluster/README.md) of the ScalarDB Cluster chart.

‎docs/configure-custom-values-scalardb-graphql.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# [Deprecated] Configure a custom values file for ScalarDB GraphQL
211

312
{% capture notice--info %}

‎docs/configure-custom-values-scalardb.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# [Deprecated] Configure a custom values file for ScalarDB Server
211

312
{% capture notice--info %}

‎docs/configure-custom-values-scalardl-auditor.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for ScalarDL Auditor
211

312
This document explains how to create your custom values file for the ScalarDL Auditor chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl-audit/README.md) of the ScalarDL Auditor chart.

‎docs/configure-custom-values-scalardl-ledger.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for ScalarDL Ledger
211

312
This document explains how to create your custom values file for the ScalarDL Ledger chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl/README.md) of the ScalarDL Ledger chart.

‎docs/configure-custom-values-scalardl-schema-loader.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Configure a custom values file for ScalarDL Schema Loader
211

312
This document explains how to create your custom values file for the ScalarDL Schema Loader chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/schema-loading/README.md) of the ScalarDL Schema Loader chart.

‎docs/getting-started-logging.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Getting Started with Helm Charts (Logging using Loki Stack)
211

312
This document explains how to get started with log aggregation for Scalar products on Kubernetes using Grafana Loki (with Promtail).

‎docs/getting-started-monitoring.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Getting Started with Helm Charts (Monitoring using Prometheus Operator)
211

312
This document explains how to get started with Scalar products monitoring on Kubernetes using Prometheus Operator (kube-prometheus-stack). Here, we assume that you already have a Mac or Linux environment for testing. We use **Minikube** in this document, but the steps we will show should work in any Kubernetes cluster.

‎docs/getting-started-scalar-helm-charts.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Getting Started with Scalar Helm Charts
211

312
This document explains how to get started with Scalar Helm Chart on a Kubernetes cluster as a test environment. Here, we assume that you already have a Mac or Linux environment for testing. We use **Minikube** in this document, but the steps we will show should work in any Kubernetes cluster.

‎docs/getting-started-scalar-manager.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Getting Started with Helm Charts (Scalar Manager)
211
Scalar Manager is a web-based dashboard that allows users to:
312
* check the health of the Scalar products

‎docs/getting-started-scalardb-analytics-postgresql.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Getting Started with Helm Charts (ScalarDB Analytics with PostgreSQL)
211

312
This guide explains how to get started with ScalarDB Analytics with PostgreSQL by using a Helm Chart in a Kubernetes cluster as a test environment. In addition, the contents of this guide assume that you already have a Mac or Linux environment set up for testing. Although **minikube** is mentioned, the steps described should work in any Kubernetes cluster.

‎docs/getting-started-scalardb.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# [Deprecated] Getting Started with Helm Charts (ScalarDB Server)
211

312
{% capture notice--info %}

‎docs/getting-started-scalardl-auditor.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Getting Started with Helm Charts (ScalarDL Ledger and Auditor / Auditor mode)
211

312
This document explains how to get started with ScalarDL Ledger and Auditor using Helm Chart on a Kubernetes cluster as a test environment. Here, we assume that you already have a Mac or Linux environment for testing. We use **Minikube** in this document, but the steps we will show should work in any Kubernetes cluster.

‎docs/getting-started-scalardl-ledger.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# Getting Started with Helm Charts (ScalarDL Ledger / Ledger only)
211

312
This document explains how to get started with ScalarDL Ledger using Helm Chart on a Kubernetes cluster as a test environment. Here, we assume that you already have a Mac or Linux environment for testing. We use **Minikube** in this document, but the steps we will show should work in any Kubernetes cluster.

‎docs/how-to-deploy-scalar-admin-for-kubernetes.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
> [!CAUTION]
2+
>
3+
> The contents of the `docs` folder have been moved to the [docs-internal-orchestration](https://github.com/scalar-labs/docs-internal-orchestration) repository. Please update this documentation in that repository instead.
4+
>
5+
> To view the Helm Charts documentation, visit the documentation site for the product you are using:
6+
>
7+
> - [ScalarDB Enterprise Documentation](https://scalardb.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
8+
> - [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/helm-charts/getting-started-scalar-helm-charts/).
9+
110
# How to deploy Scalar Admin for Kubernetes
211

312
This document explains how to deploy Scalar Admin for Kubernetes by using Scalar Helm Charts. For details on the custom values file for Scalar Admin for Kubernetes, see [Configure a custom values file for Scalar Admin for Kubernetes](./configure-custom-values-scalar-admin-for-kubernetes.md).

0 commit comments

Comments
 (0)