From 7d8b301881942866c973e7b1e6d343c22ddd7f84 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Tue, 14 Jan 2025 17:43:12 +0900 Subject: [PATCH] Update sidebar navigation for version 3.9 of English and Japanese docs (#597) * Add `docsJapanese` navigation This navigation is necessary since we will be hard-coding titles (`labels`) in the sidebar navigation in the near future. Without this, the sidebar navigation for Japanese docs would show in English. * Update sidebars * Revise Helm Chart title * Add ja-jp docs for generic contracts and error codes * Make Japanese titles consistent with ScalarDB titles Make Japanese titles consistently use noun form, as mentioned in the PR for the ScalarDB sidebar navigation (https://github.com/scalar-labs/docs-scalardb/pull/762/files/1c1b5404f5b23485105ae6a17a42977ecdc5aac3#r1869009005). * Apply suggestions from code review * Update sidebars.js Co-authored-by: Josh Wong * Apply suggestions from code review * Apply suggestions from code review Apply suggestions for consistency with suggestion in https://github.com/scalar-labs/docs-scalardl/pull/597/files#r1897305521. * Add `displayed_sidebar` metadata * Re-add mistakenly removed component * Remove unnecessary single quotation marks * Update wording * Fix wording * Fix wording --------- Co-authored-by: Jun Nemoto <35618893+jnmt@users.noreply.github.com> --- docs/index.mdx | 4 + docs/scalar-licensing/README.mdx | 4 + .../current/index.mdx | 10 +- .../current/scalar-licensing/README.mdx | 4 + .../version-3.8.json | 6 +- .../version-3.8/index.mdx | 6 +- .../version-3.9/index.mdx | 53 +- .../version-3.9/scalar-licensing/README.mdx | 4 + sidebars.js | 1115 +++++++++++++++-- src/components/Cards/3.10.tsx | 2 +- versioned_docs/version-3.9/index.mdx | 4 + .../version-3.9/scalar-licensing/README.mdx | 4 + versioned_sidebars/version-3.9-sidebars.json | 1037 +++++++++++++-- 13 files changed, 2064 insertions(+), 189 deletions(-) diff --git a/docs/index.mdx b/docs/index.mdx index 8faa3840..cb34c014 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,3 +1,7 @@ +--- +displayed_sidebar: docsEnglish +--- + # ScalarDL import { CardRowAbout, CardRowGettingStarted, CardRowSamples, CardRowDevelop, CardRowDeploy, CardRowManage, CardRowReference } from '/src/components/Cards/3.10'; diff --git a/docs/scalar-licensing/README.mdx b/docs/scalar-licensing/README.mdx index 0e4524d5..1dc4c58d 100644 --- a/docs/scalar-licensing/README.mdx +++ b/docs/scalar-licensing/README.mdx @@ -1,3 +1,7 @@ +--- +displayed_sidebar: docsEnglish +--- + # How to Configure a Product License Key import Tabs from '@theme/Tabs'; diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/index.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/index.mdx index aa9264f5..e231248b 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/index.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/index.mdx @@ -1,3 +1,7 @@ +--- +displayed_sidebar: docsJapanese +--- + # ScalarDL import { CardRowAbout, CardRowGettingStarted, CardRowSamples, CardRowDevelop, CardRowDeploy, CardRowManage, CardRowReference } from '/src/components/Cards/ja-jp/3.10'; @@ -8,11 +12,11 @@ ScalarDL は、正確性、スケーラビリティ、およびデータベー -**始めましょう** +**はじめよう** -**サンプルアプリケーション** +**サンプル** @@ -28,7 +32,7 @@ ScalarDL は、正確性、スケーラビリティ、およびデータベー -**関連情報** +**詳細** diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/scalar-licensing/README.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/scalar-licensing/README.mdx index 18d30619..ea1fd070 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/scalar-licensing/README.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/scalar-licensing/README.mdx @@ -1,3 +1,7 @@ +--- +displayed_sidebar: docsJapanese +--- + # 製品ライセンス キーの設定方法 import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8.json b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8.json index 6fedfa11..cf566c06 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8.json +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8.json @@ -8,11 +8,11 @@ "description": "The label for category About ScalarDL in sidebar docs" }, "sidebar.docs.category.Getting Started": { - "message": "始めましょう", + "message": "はじめよう", "description": "The label for category Getting Started in sidebar docs" }, "sidebar.docs.category.Samples": { - "message": "サンプルアプリケーション", + "message": "サンプル", "description": "The label for category Samples in sidebar docs" }, "sidebar.docs.category.Develop": { @@ -72,7 +72,7 @@ "description": "The label for category Backup and Restore Guides in sidebar docs" }, "sidebar.docs.category.Reference": { - "message": "関連情報", + "message": "詳細", "description": "The label for category Reference in sidebar docs" }, "sidebar.docs.category.Releases": { diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8/index.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8/index.mdx index 2bf47de8..378f80b5 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8/index.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.8/index.mdx @@ -8,11 +8,11 @@ ScalarDL は、正確性、スケーラビリティ、およびデータベー -**始めましょう** +**はじめよう** -**サンプルアプリケーション** +**サンプル** @@ -28,7 +28,7 @@ ScalarDL は、正確性、スケーラビリティ、およびデータベー -**関連情報** +**詳細** diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/index.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/index.mdx index a4868fe9..f23b2fb5 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/index.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/index.mdx @@ -1,11 +1,50 @@ -# ScalarDL: トランザクション データベース システム用のビザンチン障害検出ミドルウェア +--- +displayed_sidebar: docsJapanese +--- -import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; +# ScalarDL - +import { CardRowAbout, CardRowGettingStarted, CardRowSamples, CardRowDevelop, CardRowDeploy, CardRowManage, CardRowReference } from '/src/components/Cards/ja-jp/3.9'; -ScalarDL は、正確性、スケーラビリティ、およびデータベース不可知性を実現する、トランザクション データベース システム用のスケーラブルで実用的なビザンチン障害検出ミドルウェアです。 +ScalarDL は、正確性、スケーラビリティ、およびデータベース不可知性を実現する、トランザクションデータベースシステム用のスケーラブルで実用的なビザンチン障害検出ミドルウェアです。 -## 役立つリソース -* [ScalarDL Technical Overview](https://speakerdeck.com/scalar/scalar-dl-technical-overview) -* [ScalarDL Research Paper](https://dl.acm.org/doi/abs/10.14778/3523210.3523212) [VLDB'22] +**ScalarDL について** + + + +**はじめよう** + + + +**サンプル** + + + +**開発** + + + +**デプロイ** + + + +**運用** + + + +**詳細** + + + +{/* Saving the following in case we decide to change the layout in the future to a more table grid-like style. */} +{/* +| Category | Documentation | +|:------------------- |:--------------------- | +| **About ScalarDL** | XXX | +| **Getting started** | XXX | +| **Samples** | XXX | +| **Develop** | XXX | +| **Deploy** | XXX | +| **Manage** | XXX | +| **Reference** | XXX | +*/} diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/scalar-licensing/README.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/scalar-licensing/README.mdx index 18d30619..ea1fd070 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/scalar-licensing/README.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/scalar-licensing/README.mdx @@ -1,3 +1,7 @@ +--- +displayed_sidebar: docsJapanese +--- + # 製品ライセンス キーの設定方法 import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; diff --git a/sidebars.js b/sidebars.js index 4ca97da3..2dab28ea 100644 --- a/sidebars.js +++ b/sidebars.js @@ -18,23 +18,48 @@ const sidebars = { // But you can create a sidebar manually - docs: [ + // English sidebar nav + docsEnglish: [ { type: 'doc', label: 'ScalarDL Docs Home', id: 'index', }, { - 'type': 'category', - 'label': 'About ScalarDL', - 'collapsible': true, - 'items': [ - 'overview', - 'design', - 'implementation', - 'glossary', - 'requirements', - 'roadmap', + type: 'category', + label: 'About ScalarDL', + collapsible: true, + items: [ + { + type: 'doc', + id: 'overview', + label: 'Overview', + }, + { + type: 'doc', + id: 'design', + label: 'Design', + }, + { + type: 'doc', + id: 'implementation', + label: 'Implementation', + }, + { + type: 'doc', + id: 'glossary', + label: 'Glossary', + }, + { + type: 'doc', + id: 'requirements', + label: 'Requirements', + }, + { + type: 'doc', + id: 'roadmap', + label: 'Roadmap', + }, ] }, { @@ -42,8 +67,16 @@ const sidebars = { label: 'Getting Started', collapsible: true, items: [ - 'getting-started', - 'getting-started-auditor', + { + type: 'doc', + id: 'getting-started', + label: 'Run a Contract Through ScalarDL Ledger', + }, + { + type: 'doc', + id: 'getting-started-auditor', + label: 'Run a Contract Through ScalarDL Ledger and Auditor', + }, ], }, { @@ -51,7 +84,11 @@ const sidebars = { label: 'Samples', collapsible: true, items: [ - 'applications/simple-bank-account/README', + { + type: 'doc', + id: 'applications/simple-bank-account/README', + label: 'Bank Account Application', + }, ], }, { @@ -64,18 +101,58 @@ const sidebars = { label: 'SDKs', collapsible: true, items: [ - 'scalardl-java-client-sdk/README', + { + type: 'doc', + id: 'scalardl-java-client-sdk/README', + label: 'ScalarDL Java Client SDK', + }, ], }, - 'configurations', - 'schema-loader', - 'ca/caclient-getting-started', - 'authentication', - 'how-to-handle-errors', - 'how-to-write-contract', - 'how-to-write-function', - 'use-generic-contracts', - 'how-to-use-proof', + { + type: 'doc', + id: 'configurations', + label: 'Configurations', + }, + { + type: 'doc', + id: 'schema-loader', + label: 'ScalarDL Schema Loader', + }, + { + type: 'doc', + id: 'ca/caclient-getting-started', + label: 'Get a Certificate', + }, + { + type: 'doc', + id: 'authentication', + label: 'Authentication', + }, + { + type: 'doc', + id: 'how-to-handle-errors', + label: 'Handle Errors', + }, + { + type: 'doc', + id: 'how-to-write-contract', + label: 'Write a Contract', + }, + { + type: 'doc', + id: 'how-to-write-function', + label: 'Write a Function', + }, + { + type: 'doc', + id: 'use-generic-contracts', + label: 'Use Generic Contracts', + }, + { + type: 'doc', + id: 'how-to-use-proof', + label: 'Use Asset Proofs', + }, ], }, { @@ -93,8 +170,16 @@ const sidebars = { label: 'Database Setup Guides', collapsible: true, items: [ - 'scalar-kubernetes/SetupDatabaseForAWS', - 'scalar-kubernetes/SetupDatabaseForAzure', + { + type: 'doc', + id: 'scalar-kubernetes/SetupDatabaseForAWS', + label: 'Databases on AWS', + }, + { + type: 'doc', + id: 'scalar-kubernetes/SetupDatabaseForAzure', + label: 'Databases on Azure', + }, ], }, { @@ -102,11 +187,31 @@ const sidebars = { label: 'Installation Guides', collapsible: true, items: [ - 'scalar-kubernetes/ProductionChecklistForScalarDLLedger', - 'scalar-kubernetes/ProductionChecklistForScalarDLAuditor', - 'scalar-kubernetes/AwsMarketplaceGuide', - 'scalar-kubernetes/AzureMarketplaceGuide', - 'scalar-kubernetes/CreateBastionServer', + { + type: 'doc', + id: 'scalar-kubernetes/ProductionChecklistForScalarDLLedger', + label: 'Production checklist for ScalarDL Ledger', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ProductionChecklistForScalarDLAuditor', + label: 'Production checklist for ScalarDL Auditor', + }, + { + type: 'doc', + id: 'scalar-kubernetes/AwsMarketplaceGuide', + label: 'Install from AWS Marketplace', + }, + { + type: 'doc', + id: 'scalar-kubernetes/AzureMarketplaceGuide', + label: 'Install from Azure Marketplace', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateBastionServer', + label: 'Create a Bastion Server', + }, ], }, { @@ -114,10 +219,26 @@ const sidebars = { label: 'Cluster Guides', collapsible: true, items: [ - 'scalar-kubernetes/CreateEKSClusterForScalarDL', - 'scalar-kubernetes/CreateEKSClusterForScalarDLAuditor', - 'scalar-kubernetes/CreateAKSClusterForScalarDL', - 'scalar-kubernetes/CreateAKSClusterForScalarDLAuditor', + { + type: 'doc', + id: 'scalar-kubernetes/CreateEKSClusterForScalarDL', + label: 'Create an EKS Cluster for ScalarDL Ledger', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateEKSClusterForScalarDLAuditor', + label: 'Create an EKS Cluster for ScalarDL Ledger and Auditor', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateAKSClusterForScalarDL', + label: 'Create an AKS cluster for ScalarDL Ledger', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateAKSClusterForScalarDLAuditor', + label: 'Create an AKS cluster for ScalarDL Ledger and Auditor', + }, ], }, { @@ -125,8 +246,16 @@ const sidebars = { label: 'Container Image Guides', collapsible: true, items: [ - 'scalar-kubernetes/HowToGetContainerImages', - 'scalar-kubernetes/HowToUseContainerImages', + { + type: 'doc', + id: 'scalar-kubernetes/HowToGetContainerImages', + label: 'Get Container Images', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToUseContainerImages', + label: 'Use Container Images', + }, ], }, { @@ -134,10 +263,26 @@ const sidebars = { label: 'Deployment Guides', collapsible: true, items: [ - 'scalar-kubernetes/ManualDeploymentGuideScalarDLOnEKS', - 'scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnEKS', - 'scalar-kubernetes/ManualDeploymentGuideScalarDLOnAKS', - 'scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnAKS', + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLOnEKS', + label: 'Deploy ScalarDL Ledger on Amazon EKS', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnEKS', + label: 'Deploy ScalarDL Ledger and Auditor on Amazon EKS', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLOnAKS', + label: 'Deploy ScalarDL Ledger on AKS', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnAKS', + label: 'Deploy ScalarDL Ledger and Auditor on AKS', + }, ], }, { @@ -145,9 +290,21 @@ const sidebars = { label: 'Configuration Guides', collapsible: true, items: [ - 'scalar-kubernetes/AccessScalarProducts', - 'scalar-kubernetes/HowToCreateKeyAndCertificateFiles', - 'scalar-kubernetes/NetworkPeeringForScalarDLAuditor', + { + type: 'doc', + id: 'scalar-kubernetes/AccessScalarProducts', + label: 'Access Kubernetes Environment from Applications', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToCreateKeyAndCertificateFiles', + label: 'Create Private Key and Certificate Files', + }, + { + type: 'doc', + id: 'scalar-kubernetes/NetworkPeeringForScalarDLAuditor', + label: 'Configure Network Peering for ScalarDL Auditor', + }, ], }, ], @@ -162,40 +319,132 @@ const sidebars = { label: 'Getting Started', collapsible: true, items: [ - 'helm-charts/getting-started-scalar-helm-charts', - 'helm-charts/getting-started-scalardl-ledger', - 'helm-charts/getting-started-scalardl-auditor', - 'helm-charts/getting-started-scalardl-auditor-tls', - 'helm-charts/getting-started-scalardl-auditor-tls-cert-manager', - 'helm-charts/getting-started-monitoring', - 'helm-charts/getting-started-logging', - 'helm-charts/getting-started-scalar-manager', + { + type: 'doc', + id: 'helm-charts/getting-started-scalar-helm-charts', + label: 'Use Scalar Helm Charts', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-ledger', + label: 'ScalarDL Ledger by Using a Helm Chart', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-auditor', + label: 'ScalarDL Ledger and Auditor by Using a Helm Chart', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-auditor-tls', + label: 'ScalarDL Ledger and Auditor with TLS by Using a Helm Chart', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-auditor-tls-cert-manager', + label: 'ScalarDL Ledger and Auditor with TLS by Using cert-manager and a Helm Chart', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-monitoring', + label: 'Prometheus Operator for Monitoring by Using a Helm Chart', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-logging', + label: 'Loki Stack for Logging by Using a Helm Chart by Using a Helm Chart', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalar-manager', + label: 'Scalar Manager by Using a Helm Chart', + }, ] }, { type: 'category', - label: 'Configure custom values', + label: 'Configure Custom Values', collapsible: true, items: [ - 'helm-charts/configure-custom-values-scalardl-ledger', - 'helm-charts/configure-custom-values-scalardl-auditor', - 'helm-charts/configure-custom-values-scalardl-schema-loader', - 'helm-charts/configure-custom-values-scalar-admin-for-kubernetes', - 'helm-charts/configure-custom-values-scalar-manager', - 'helm-charts/configure-custom-values-envoy', + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalardl-ledger', + label: 'Configure a Custom Values File for ScalarDL Ledger', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalardl-auditor', + label: 'Configure a Custom Values File for ScalarDL Auditor', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalardl-schema-loader', + label: 'Configure a Custom Values File for ScalarDL Schema Loader', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalar-admin-for-kubernetes', + label: 'Configure a Custom Values File for Scalar Admin for Kubernetes', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalar-manager', + label: 'Configure a Custom Values File for Scalar Manager', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-envoy', + label: 'Configure a Custom Values File for Scalar Envoy', + }, ], }, - 'helm-charts/how-to-deploy-scalar-products', - 'helm-charts/how-to-deploy-scalardl-ledger', - 'helm-charts/how-to-deploy-scalardl-auditor', - 'helm-charts/how-to-deploy-scalar-admin-for-kubernetes', - 'helm-charts/mount-files-or-volumes-on-scalar-pods', - 'helm-charts/use-secret-for-credentials', + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalar-products', + label: 'Deploy Scalar Products Using Scalar Helm Charts', + }, + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalardl-ledger', + label: 'Deploy ScalarDL Ledger', + }, + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalardl-auditor', + label: 'Deploy ScalarDL Auditor', + }, + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalar-admin-for-kubernetes', + label: 'Deploy Scalar Admin for Kubernetes', + }, + { + type: 'doc', + id: 'helm-charts/mount-files-or-volumes-on-scalar-pods', + label: 'Mount Files or Volumes on ScalarDL Pods', + }, + { + type: 'doc', + id: 'helm-charts/use-secret-for-credentials', + label: 'Use Secret Resources', + }, ], }, - 'scalar-licensing/README', - 'installation-with-docker', - 'ca/caserver-getting-started', + { + type: 'doc', + id: 'scalar-licensing/README', + label: 'Configure a Product License Key', + }, + { + type: 'doc', + id: 'installation-with-docker', + label: 'Install ScalarDL in Your Local Environment with Docker', + }, + { + type: 'doc', + id: 'ca/caserver-getting-started', + label: 'Start CA Server with CFSSL', + }, ], }, { @@ -218,12 +467,28 @@ const sidebars = { label: 'Alerts', collapsible: true, items: [ - 'scalar-kubernetes/alerts/Envoy', - 'scalar-kubernetes/alerts/Ledger', + { + type: 'doc', + id: 'scalar-kubernetes/alerts/Envoy', + label: 'Envoy Alerts', + }, + { + type: 'doc', + id: 'scalar-kubernetes/alerts/Ledger', + label: 'Ledger Alerts', + }, ], }, - 'scalar-kubernetes/K8sMonitorGuide', - 'scalar-kubernetes/K8sLogCollectionGuide', + { + type: 'doc', + id: 'scalar-kubernetes/K8sMonitorGuide', + label: 'Kubernetes Monitoring Guide', + }, + { + type: 'doc', + id: 'scalar-kubernetes/K8sLogCollectionGuide', + label: 'Collect Logs from ScalarDL on a Kubernetes Cluster', + }, ], }, { @@ -231,19 +496,55 @@ const sidebars = { label: 'Backup and Restore Guides', collapsible: true, items: [ - 'scalar-kubernetes/BackupRestoreGuide', - 'scalar-kubernetes/BackupRDB', - 'scalar-kubernetes/BackupNoSQL', - 'scalar-kubernetes/RestoreDatabase', - 'scalar-kubernetes/RegularCheck', + { + type: 'doc', + id: 'scalar-kubernetes/BackupRestoreGuide', + label: 'Back Up and Restore ScalarDL Data in Kubernetes', + }, + { + type: 'doc', + id: 'scalar-kubernetes/BackupRDB', + label: 'Back Up an RDB in Kubernetes', + }, + { + type: 'doc', + id: 'scalar-kubernetes/BackupNoSQL', + label: 'Back Up a NoSQL Database in Kubernetes', + }, + { + type: 'doc', + id: 'scalar-kubernetes/RestoreDatabase', + label: 'Restore Databases in Kubernetes', + }, + { + type: 'doc', + id: 'scalar-kubernetes/RegularCheck', + label: 'Components to Regularly Check When Running on Kubernetes', + }, ], }, ], }, - 'backup-restore', - 'scalar-kubernetes/HowToScaleScalarDL', - 'scalar-kubernetes/HowToUpgradeScalarDL', - 'scalar-manager/overview', + { + type: 'doc', + id: 'backup-restore', + label: 'Backup and Restore Data', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToScaleScalarDL', + label: 'Scale', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToUpgradeScalarDL', + label: 'Upgrade', + }, + { + type: 'doc', + id: 'scalar-manager/overview', + label: 'Scalar Manager Overview', + }, ], }, { @@ -251,19 +552,51 @@ const sidebars = { label: 'Reference', collapsible: true, items: [ - 'compatibility', - 'scalardl-command-reference', - 'generic-contracts-reference', - 'scalardl-benchmarks/README', + { + type: 'doc', + id: 'compatibility', + label: 'Compatibility Matrix', + }, + { + type: 'doc', + id: 'scalardl-command-reference', + label: 'Client Commands', + }, + { + type: 'doc', + id: 'generic-contracts-reference', + label: 'Generic Contracts', + }, + { + type: 'doc', + id: 'scalardl-benchmarks/README', + label: 'Run Benchmarks', + }, { type: 'category', label: 'Error codes', collapsible: true, items: [ - 'scalardl-auditor-status-codes', - 'scalardl-client-status-codes', - 'scalardl-common-status-codes', - 'scalardl-ledger-status-codes', + { + type: 'doc', + id: 'scalardl-common-status-codes', + label: 'ScalarDL Common Error Codes', + }, + { + type: 'doc', + id: 'scalardl-ledger-status-codes', + label: 'ScalarDL Ledger Error Codes', + }, + { + type: 'doc', + id: 'scalardl-auditor-status-codes', + label: 'ScalarDL Auditor Error Codes', + }, + { + type: 'doc', + id: 'scalardl-client-status-codes', + label: 'ScalarDL Client Error Codes', + }, ], }, ], @@ -273,8 +606,608 @@ const sidebars = { label: 'Releases', collapsible: true, items: [ - 'releases/release-notes', - 'releases/release-support-policy', + { + type: 'doc', + id: 'releases/release-notes', + label: 'Release Notes', + }, + { + type: 'doc', + id: 'releases/release-support-policy', + label: 'Release Support Policy', + }, + ], + }, + ], + + // Japanese sidebar nav + docsJapanese: [ + { + type: 'doc', + label: 'ScalarDL ドキュメンテーションホーム', + id: 'index', + }, + { + type: 'category', + label: 'ScalarDL について', + collapsible: true, + items: [ + { + type: 'doc', + id: 'overview', + label: '概要', + }, + { + type: 'doc', + id: 'design', + label: 'デザイン', + }, + { + type: 'doc', + id: 'implementation', + label: '実装', + }, + { + type: 'doc', + id: 'requirements', + label: '要件', + }, + { + type: 'doc', + id: 'roadmap', + label: 'ロードマップ', + }, + ] + }, + { + type: 'category', + label: 'はじめよう', + collapsible: true, + items: [ + { + type: 'doc', + id: 'getting-started', + label: 'ScalarDL Ledger を通じてコントラクトを実行', + }, + { + type: 'doc', + id: 'getting-started-auditor', + label: 'ScalarDL Ledger と Auditor を通じてコントラクトを実行', + }, + ], + }, + { + type: 'category', + label: 'サンプル', + collapsible: true, + items: [ + { + type: 'doc', + id: 'applications/simple-bank-account/README', + label: '銀行口座アプリケーション', + }, + ], + }, + { + type: 'category', + label: '開発', + collapsible: true, + items: [ + { + type: 'category', + label: 'SDKs', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardl-java-client-sdk/README', + label: 'ScalarDL Java Client SDK', + }, + ], + }, + { + type: 'doc', + id: 'configurations', + label: '設定', + }, + { + type: 'doc', + id: 'schema-loader', + label: 'ScalarDL Schema Loader', + }, + { + type: 'doc', + id: 'ca/caclient-getting-started', + label: '証明書を取得', + }, + { + type: 'doc', + id: 'authentication', + label: '認証', + }, + { + type: 'doc', + id: 'how-to-handle-errors', + label: 'エラーハンドリング', + }, + { + type: 'doc', + id: 'how-to-write-contract', + label: 'コントラクトを作成', + }, + { + type: 'doc', + id: 'how-to-write-function', + label: 'ファンクションを作成', + }, + { + type: 'doc', + id: 'use-generic-contracts', + label: '汎用コントラクトを使用', + }, + { + type: 'doc', + id: 'how-to-use-proof', + label: 'アセットプルーフを使用', + }, + ], + }, + { + type: 'category', + label: 'デプロイ', + collapsible: true, + items: [ + { + type: 'category', + label: 'Scalar Kubernetes', + collapsible: true, + items: [ + { + type: 'category', + label: 'データベースセットアップガイド', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/SetupDatabaseForAWS', + label: 'AWS が提供するデータベース', + }, + { + type: 'doc', + id: 'scalar-kubernetes/SetupDatabaseForAzure', + label: 'Azure が提供するデータベース', + }, + ], + }, + { + type: 'category', + label: 'インストールガイド', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/ProductionChecklistForScalarDLLedger', + label: 'ScalarDL Ledger の本番環境チェックリスト', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ProductionChecklistForScalarDLAuditor', + label: 'ScalarDL Auditor の本番環境チェックリスト', + }, + { + type: 'doc', + id: 'scalar-kubernetes/AwsMarketplaceGuide', + label: 'AWS Marketplace からインストール', + }, + { + type: 'doc', + id: 'scalar-kubernetes/AzureMarketplaceGuide', + label: 'Azure Marketplace からインストール', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateBastionServer', + label: '踏み台サーバーを作成', + }, + ], + }, + { + type: 'category', + label: 'クラスターガイド', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/CreateEKSClusterForScalarDL', + label: 'ScalarDL Ledger 用の EKS クラスターを作成', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateEKSClusterForScalarDLAuditor', + label: 'ScalarDL Ledger と Auditor 用の EKS クラスターを作成', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateAKSClusterForScalarDL', + label: 'ScalarDL Ledger 用の AKS クラスターを作成', + }, + { + type: 'doc', + id: 'scalar-kubernetes/CreateAKSClusterForScalarDLAuditor', + label: 'ScalarDL Ledger と Auditor 用の AKS クラスターを作成', + }, + ], + }, + { + type: 'category', + label: 'コンテナイメージガイド', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/HowToGetContainerImages', + label: 'コンテナイメージを取得', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToUseContainerImages', + label: 'コンテナイメージを使用', + }, + ], + }, + { + type: 'category', + label: 'デプロイメントガイド', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLOnEKS', + label: 'Amazon EKS に ScalarDL Ledger をデプロイ', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnEKS', + label: 'Amazon EKS に ScalarDL Ledger と Auditorをデプロイ', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLOnAKS', + label: 'AKS に ScalarDL Ledger をデプロイ', + }, + { + type: 'doc', + id: 'scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnAKS', + label: 'AKS に ScalarDL Ledger と Auditor をデプロイ', + }, + ], + }, + { + type: 'category', + label: '設定のガイド', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/AccessScalarProducts', + label: 'アプリケーションから Kubernetes 環境にアクセス', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToCreateKeyAndCertificateFiles', + label: '秘密鍵と証明書ファイルを作成', + }, + { + type: 'doc', + id: 'scalar-kubernetes/NetworkPeeringForScalarDLAuditor', + label: 'ネットワークピアリングを構成', + }, + ], + }, + ], + }, + { + type: 'category', + label: 'Scalar Helm Charts', + collapsible: true, + items: [ + { + type: 'category', + label: 'はじめよう', + collapsible: true, + items: [ + { + type: 'doc', + id: 'helm-charts/getting-started-scalar-helm-charts', + label: 'Scalar Helm Charts をはじめよう', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-ledger', + label: 'Helm Chart を使用した ScalarDL Ledger', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-auditor', + label: 'Helm Chart を使用した ScalarDL Ledger と Auditor', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-auditor-tls', + label: 'Helm Chart を使用した TLS 対応 ScalarDL Ledger と Auditor', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalardl-auditor-tls-cert-manager', + label: 'cert-manager と Helm Chart を使用した TLS 対応 ScalarDL Ledger と Auditor', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-monitoring', + label: 'Helm Chart を使用した監視用 Prometheus Operator', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-logging', + label: 'Helm Chart を使用したログ記録用 Loki スタック', + }, + { + type: 'doc', + id: 'helm-charts/getting-started-scalar-manager', + label: 'Helm Chart を使用した Scalar Manager', + }, + ] + }, + { + type: 'category', + label: 'カスタム値を設定', + collapsible: true, + items: [ + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalardl-ledger', + label: 'ScalarDL Ledger のカスタム値ファイルを構成', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalardl-auditor', + label: 'ScalarDL Auditor のカスタム値ファイルを構成', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalardl-schema-loader', + label: 'ScalarDL Schema Loader のカスタム値ファイルを構成', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalar-admin-for-kubernetes', + label: 'Scalar Admin for Kubernetes のカスタム値ファイルを構成', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-scalar-manager', + label: 'Scalar Manager のカスタム値ファイルを構成', + }, + { + type: 'doc', + id: 'helm-charts/configure-custom-values-envoy', + label: 'Scalar Envoy のカスタム値ファイルを構成', + }, + ], + }, + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalar-products', + label: 'Helm Chart を使用して Scalar 製品をデプロイ', + }, + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalardl-ledger', + label: 'Helm Chart を使用して ScalarDL Ledger をデプロイ', + }, + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalardl-auditor', + label: 'Helm Chart を使用して ScalarDL Auditor をデプロイ', + }, + { + type: 'doc', + id: 'helm-charts/how-to-deploy-scalar-admin-for-kubernetes', + label: 'Helm Chart を使用して Scalar Admin for Kubernetes をデプロイ', + }, + { + type: 'doc', + id: 'helm-charts/mount-files-or-volumes-on-scalar-pods', + label: 'ScalarDL ポッドにファイルまたはボリュームをマウント', + }, + { + type: 'doc', + id: 'helm-charts/use-secret-for-credentials', + label: 'シークレットリソースを使用', + }, + ], + }, + { + type: 'doc', + id: 'scalar-licensing/README', + label: '製品ライセンスキーの設定', + }, + { + type: 'doc', + id: 'installation-with-docker', + label: 'Docker を使ってローカル環境に ScalarDL をインストール', + }, + { + type: 'doc', + id: 'ca/caserver-getting-started', + label: 'CFSSL で CA サーバーを起動', + }, + ], + }, + { + type: 'category', + label: '運用', + collapsible: true, + items: [ + { + type: 'category', + label: 'Scalar Kubernetes', + collapsible: true, + items: [ + { + type: 'category', + label: 'モニタリングガイド', + collapsible: true, + items: [ + { + type: 'category', + label: 'アラート', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/alerts/Envoy', + label: 'Envoy アラート', + }, + { + type: 'doc', + id: 'scalar-kubernetes/alerts/Ledger', + label: 'Ledger アラート', + }, + ], + }, + { + type: 'doc', + id: 'scalar-kubernetes/K8sMonitorGuide', + label: 'Kubernetes モニタリングガイド', + }, + { + type: 'doc', + id: 'scalar-kubernetes/K8sLogCollectionGuide', + label: 'Kubernetes ログ収集ガイド', + }, + ], + }, + { + type: 'category', + label: 'バックアップと復元のガイド', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalar-kubernetes/BackupRestoreGuide', + label: 'Kubernetes 環境で ScalarDL データをバックアップおよび復元', + }, + { + type: 'doc', + id: 'scalar-kubernetes/BackupRDB', + label: 'Kubernetes 環境で RDB をバックアップ', + }, + { + type: 'doc', + id: 'scalar-kubernetes/BackupNoSQL', + label: 'Kubernetes 環境で NoSQL データベースをバックアップ', + }, + { + type: 'doc', + id: 'scalar-kubernetes/RestoreDatabase', + label: 'Kubernetes 環境でデータベースを復元', + }, + { + type: 'doc', + id: 'scalar-kubernetes/RegularCheck', + label: 'Kubernetes 環境で実行するときに定期的にチェックするコンポーネント', + }, + ], + }, + ], + }, + { + type: 'doc', + id: 'backup-restore', + label: 'データのバックアップと復元', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToScaleScalarDL', + label: 'スケーリング', + }, + { + type: 'doc', + id: 'scalar-kubernetes/HowToUpgradeScalarDL', + label: 'アップグレード', + }, + { + type: 'doc', + id: 'scalar-manager/overview', + label: 'Scalar Manager の概要', + }, + ], + }, + { + type: 'category', + label: '詳細', + collapsible: true, + items: [ + { + type: 'doc', + id: 'compatibility', + label: '互換性マトリックス', + }, + { + type: 'doc', + id: 'scalardl-command-reference', + label: 'クライアントコマンドリファレンス', + }, + { + type: 'doc', + id: 'scalardl-benchmarks/README', + label: 'ベンチマークを実行', + }, + { + type: 'category', + label: 'Error codes', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardl-common-status-codes', + label: 'ScalarDL 共通エラーコード', + }, + { + type: 'doc', + id: 'scalardl-ledger-status-codes', + label: 'ScalarDL Ledger エラーコード', + }, + { + type: 'doc', + id: 'scalardl-auditor-status-codes', + label: 'ScalarDL Auditor エラーコード', + }, + { + type: 'doc', + id: 'scalardl-client-status-codes', + label: 'ScalarDL クライアントエラーコード', + }, + ], + }, + ], + }, + { + type: 'category', + label: 'リリース', + collapsible: true, + items: [ + { + type: 'doc', + id: 'releases/release-notes', + label: 'リリースノート', + }, + { + type: 'doc', + id: 'releases/release-support-policy', + label: 'リリースサポートポリシー', + }, ], }, ], diff --git a/src/components/Cards/3.10.tsx b/src/components/Cards/3.10.tsx index 31d7d221..6f741d1c 100644 --- a/src/components/Cards/3.10.tsx +++ b/src/components/Cards/3.10.tsx @@ -87,7 +87,7 @@ const CardsSamples = [ }, description: ( - Create a bank account application + Run a bank account application ), }, diff --git a/versioned_docs/version-3.9/index.mdx b/versioned_docs/version-3.9/index.mdx index 8c19a111..8e00deb0 100644 --- a/versioned_docs/version-3.9/index.mdx +++ b/versioned_docs/version-3.9/index.mdx @@ -1,3 +1,7 @@ +--- +displayed_sidebar: docsEnglish +--- + # ScalarDL import { CardRowAbout, CardRowGettingStarted, CardRowSamples, CardRowDevelop, CardRowDeploy, CardRowManage, CardRowReference } from '/src/components/Cards/3.9'; diff --git a/versioned_docs/version-3.9/scalar-licensing/README.mdx b/versioned_docs/version-3.9/scalar-licensing/README.mdx index 4b7c52c1..ac2757ab 100644 --- a/versioned_docs/version-3.9/scalar-licensing/README.mdx +++ b/versioned_docs/version-3.9/scalar-licensing/README.mdx @@ -1,3 +1,7 @@ +--- +displayed_sidebar: docsEnglish +--- + # How to Configure a Product License Key import Tabs from '@theme/Tabs'; diff --git a/versioned_sidebars/version-3.9-sidebars.json b/versioned_sidebars/version-3.9-sidebars.json index adf88069..e05662d8 100644 --- a/versioned_sidebars/version-3.9-sidebars.json +++ b/versioned_sidebars/version-3.9-sidebars.json @@ -1,5 +1,5 @@ { - "docs": [ + "docsEnglish": [ { "type": "doc", "label": "ScalarDL Docs Home", @@ -10,12 +10,36 @@ "label": "About ScalarDL", "collapsible": true, "items": [ - "overview", - "design", - "implementation", - "glossary", - "requirements", - "roadmap" + { + "type": "doc", + "id": "overview", + "label": "Overview" + }, + { + "type": "doc", + "id": "design", + "label": "Design" + }, + { + "type": "doc", + "id": "implementation", + "label": "Implementation" + }, + { + "type": "doc", + "id": "glossary", + "label": "Glossary" + }, + { + "type": "doc", + "id": "requirements", + "label": "Requirements" + }, + { + "type": "doc", + "id": "roadmap", + "label": "Roadmap" + } ] }, { @@ -23,8 +47,16 @@ "label": "Getting Started", "collapsible": true, "items": [ - "getting-started", - "getting-started-auditor" + { + "type": "doc", + "id": "getting-started", + "label": "Run a Contract Through ScalarDL Ledger" + }, + { + "type": "doc", + "id": "getting-started-auditor", + "label": "Run a Contract Through ScalarDL Ledger and Auditor" + } ] }, { @@ -32,7 +64,11 @@ "label": "Samples", "collapsible": true, "items": [ - "applications/simple-bank-account/README" + { + "type": "doc", + "id": "applications/simple-bank-account/README", + "label": "Bank Account Application" + } ] }, { @@ -45,17 +81,53 @@ "label": "SDKs", "collapsible": true, "items": [ - "scalardl-java-client-sdk/README" + { + "type": "doc", + "id": "scalardl-java-client-sdk/README", + "label": "ScalarDL Java Client SDK" + } ] }, - "configurations", - "schema-loader", - "ca/caclient-getting-started", - "authentication", - "how-to-handle-errors", - "how-to-write-contract", - "how-to-write-function", - "how-to-use-proof" + { + "type": "doc", + "id": "configurations", + "label": "Configurations" + }, + { + "type": "doc", + "id": "schema-loader", + "label": "ScalarDL Schema Loader" + }, + { + "type": "doc", + "id": "ca/caclient-getting-started", + "label": "Get a Certificate" + }, + { + "type": "doc", + "id": "authentication", + "label": "Authentication" + }, + { + "type": "doc", + "id": "how-to-handle-errors", + "label": "Handle Errors" + }, + { + "type": "doc", + "id": "how-to-write-contract", + "label": "Write a Contract" + }, + { + "type": "doc", + "id": "how-to-write-function", + "label": "Write a Function" + }, + { + "type": "doc", + "id": "how-to-use-proof", + "label": "Use Asset Proofs" + } ] }, { @@ -73,8 +145,16 @@ "label": "Database Setup Guides", "collapsible": true, "items": [ - "scalar-kubernetes/SetupDatabaseForAWS", - "scalar-kubernetes/SetupDatabaseForAzure" + { + "type": "doc", + "id": "scalar-kubernetes/SetupDatabaseForAWS", + "label": "Databases on AWS" + }, + { + "type": "doc", + "id": "scalar-kubernetes/SetupDatabaseForAzure", + "label": "Databases on Azure" + } ] }, { @@ -82,11 +162,31 @@ "label": "Installation Guides", "collapsible": true, "items": [ - "scalar-kubernetes/ProductionChecklistForScalarDLLedger", - "scalar-kubernetes/ProductionChecklistForScalarDLAuditor", - "scalar-kubernetes/AwsMarketplaceGuide", - "scalar-kubernetes/AzureMarketplaceGuide", - "scalar-kubernetes/CreateBastionServer" + { + "type": "doc", + "id": "scalar-kubernetes/ProductionChecklistForScalarDLLedger", + "label": "Production checklist for ScalarDL Ledger" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ProductionChecklistForScalarDLAuditor", + "label": "Production checklist for ScalarDL Auditor" + }, + { + "type": "doc", + "id": "scalar-kubernetes/AwsMarketplaceGuide", + "label": "Install from AWS Marketplace" + }, + { + "type": "doc", + "id": "scalar-kubernetes/AzureMarketplaceGuide", + "label": "Install from Azure Marketplace" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateBastionServer", + "label": "Create a Bastion Server" + } ] }, { @@ -94,10 +194,26 @@ "label": "Cluster Guides", "collapsible": true, "items": [ - "scalar-kubernetes/CreateEKSClusterForScalarDL", - "scalar-kubernetes/CreateEKSClusterForScalarDLAuditor", - "scalar-kubernetes/CreateAKSClusterForScalarDL", - "scalar-kubernetes/CreateAKSClusterForScalarDLAuditor" + { + "type": "doc", + "id": "scalar-kubernetes/CreateEKSClusterForScalarDL", + "label": "Create an EKS Cluster for ScalarDL Ledger" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateEKSClusterForScalarDLAuditor", + "label": "Create an EKS Cluster for ScalarDL Ledger and Auditor" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateAKSClusterForScalarDL", + "label": "Create an AKS cluster for ScalarDL Ledger" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateAKSClusterForScalarDLAuditor", + "label": "Create an AKS cluster for ScalarDL Ledger and Auditor" + } ] }, { @@ -105,8 +221,16 @@ "label": "Container Image Guides", "collapsible": true, "items": [ - "scalar-kubernetes/HowToGetContainerImages", - "scalar-kubernetes/HowToUseContainerImages" + { + "type": "doc", + "id": "scalar-kubernetes/HowToGetContainerImages", + "label": "Get Container Images" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToUseContainerImages", + "label": "Use Container Images" + } ] }, { @@ -114,10 +238,26 @@ "label": "Deployment Guides", "collapsible": true, "items": [ - "scalar-kubernetes/ManualDeploymentGuideScalarDLOnEKS", - "scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnEKS", - "scalar-kubernetes/ManualDeploymentGuideScalarDLOnAKS", - "scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnAKS" + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLOnEKS", + "label": "Deploy ScalarDL Ledger on Amazon EKS" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnEKS", + "label": "Deploy ScalarDL Ledger and Auditor on Amazon EKS" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLOnAKS", + "label": "Deploy ScalarDL Ledger on AKS" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnAKS", + "label": "Deploy ScalarDL Ledger and Auditor on AKS" + } ] }, { @@ -125,9 +265,21 @@ "label": "Configuration Guides", "collapsible": true, "items": [ - "scalar-kubernetes/AccessScalarProducts", - "scalar-kubernetes/HowToCreateKeyAndCertificateFiles", - "scalar-kubernetes/NetworkPeeringForScalarDLAuditor" + { + "type": "doc", + "id": "scalar-kubernetes/AccessScalarProducts", + "label": "Access Kubernetes Environment from Applications" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToCreateKeyAndCertificateFiles", + "label": "Create Private Key and Certificate Files" + }, + { + "type": "doc", + "id": "scalar-kubernetes/NetworkPeeringForScalarDLAuditor", + "label": "Configure Network Peering for ScalarDL Auditor" + } ] } ] @@ -142,40 +294,132 @@ "label": "Getting Started", "collapsible": true, "items": [ - "helm-charts/getting-started-scalar-helm-charts", - "helm-charts/getting-started-scalardl-ledger", - "helm-charts/getting-started-scalardl-auditor", - "helm-charts/getting-started-scalardl-auditor-tls", - "helm-charts/getting-started-scalardl-auditor-tls-cert-manager", - "helm-charts/getting-started-monitoring", - "helm-charts/getting-started-logging", - "helm-charts/getting-started-scalar-manager" + { + "type": "doc", + "id": "helm-charts/getting-started-scalar-helm-charts", + "label": "Use Scalar Helm Charts" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-ledger", + "label": "ScalarDL Ledger by Using a Helm Chart" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-auditor", + "label": "ScalarDL Ledger and Auditor by Using a Helm Chart" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-auditor-tls", + "label": "ScalarDL Ledger and Auditor with TLS by Using a Helm Chart" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-auditor-tls-cert-manager", + "label": "ScalarDL Ledger and Auditor with TLS by Using cert-manager and a Helm Chart" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-monitoring", + "label": "Prometheus Operator for Monitoring by Using a Helm Chart" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-logging", + "label": "Loki Stack for Logging by Using a Helm Chart by Using a Helm Chart" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalar-manager", + "label": "Scalar Manager by Using a Helm Chart" + } ] }, { "type": "category", - "label": "Configure custom values", + "label": "Configure Custom Values", "collapsible": true, "items": [ - "helm-charts/configure-custom-values-scalardl-ledger", - "helm-charts/configure-custom-values-scalardl-auditor", - "helm-charts/configure-custom-values-scalardl-schema-loader", - "helm-charts/configure-custom-values-scalar-admin-for-kubernetes", - "helm-charts/configure-custom-values-scalar-manager", - "helm-charts/configure-custom-values-envoy" + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalardl-ledger", + "label": "Configure a Custom Values File for ScalarDL Ledger" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalardl-auditor", + "label": "Configure a Custom Values File for ScalarDL Auditor" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalardl-schema-loader", + "label": "Configure a Custom Values File for ScalarDL Schema Loader" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalar-admin-for-kubernetes", + "label": "Configure a Custom Values File for Scalar Admin for Kubernetes" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalar-manager", + "label": "Configure a Custom Values File for Scalar Manager" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-envoy", + "label": "Configure a Custom Values File for Scalar Envoy" + } ] }, - "helm-charts/how-to-deploy-scalar-products", - "helm-charts/how-to-deploy-scalardl-ledger", - "helm-charts/how-to-deploy-scalardl-auditor", - "helm-charts/how-to-deploy-scalar-admin-for-kubernetes", - "helm-charts/mount-files-or-volumes-on-scalar-pods", - "helm-charts/use-secret-for-credentials" + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalar-products", + "label": "Deploy Scalar Products Using Scalar Helm Charts" + }, + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalardl-ledger", + "label": "Deploy ScalarDL Ledger" + }, + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalardl-auditor", + "label": "Deploy ScalarDL Auditor" + }, + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalar-admin-for-kubernetes", + "label": "Deploy Scalar Admin for Kubernetes" + }, + { + "type": "doc", + "id": "helm-charts/mount-files-or-volumes-on-scalar-pods", + "label": "Mount Files or Volumes on ScalarDL Pods" + }, + { + "type": "doc", + "id": "helm-charts/use-secret-for-credentials", + "label": "Use Secret Resources" + } ] }, - "scalar-licensing/README", - "installation-with-docker", - "ca/caserver-getting-started" + { + "type": "doc", + "id": "scalar-licensing/README", + "label": "Configure a Product License Key" + }, + { + "type": "doc", + "id": "installation-with-docker", + "label": "Install ScalarDL in Your Local Environment with Docker" + }, + { + "type": "doc", + "id": "ca/caserver-getting-started", + "label": "Start CA Server with CFSSL" + } ] }, { @@ -198,12 +442,28 @@ "label": "Alerts", "collapsible": true, "items": [ - "scalar-kubernetes/alerts/Envoy", - "scalar-kubernetes/alerts/Ledger" + { + "type": "doc", + "id": "scalar-kubernetes/alerts/Envoy", + "label": "Envoy Alerts" + }, + { + "type": "doc", + "id": "scalar-kubernetes/alerts/Ledger", + "label": "Ledger Alerts" + } ] }, - "scalar-kubernetes/K8sMonitorGuide", - "scalar-kubernetes/K8sLogCollectionGuide" + { + "type": "doc", + "id": "scalar-kubernetes/K8sMonitorGuide", + "label": "Kubernetes Monitoring Guide" + }, + { + "type": "doc", + "id": "scalar-kubernetes/K8sLogCollectionGuide", + "label": "Collect Logs from ScalarDL on a Kubernetes Cluster" + } ] }, { @@ -211,19 +471,55 @@ "label": "Backup and Restore Guides", "collapsible": true, "items": [ - "scalar-kubernetes/BackupRestoreGuide", - "scalar-kubernetes/BackupRDB", - "scalar-kubernetes/BackupNoSQL", - "scalar-kubernetes/RestoreDatabase", - "scalar-kubernetes/RegularCheck" + { + "type": "doc", + "id": "scalar-kubernetes/BackupRestoreGuide", + "label": "Back Up and Restore ScalarDL Data in Kubernetes" + }, + { + "type": "doc", + "id": "scalar-kubernetes/BackupRDB", + "label": "Back Up an RDB in Kubernetes" + }, + { + "type": "doc", + "id": "scalar-kubernetes/BackupNoSQL", + "label": "Back Up a NoSQL Database in Kubernetes" + }, + { + "type": "doc", + "id": "scalar-kubernetes/RestoreDatabase", + "label": "Restore Databases in Kubernetes" + }, + { + "type": "doc", + "id": "scalar-kubernetes/RegularCheck", + "label": "Components to Regularly Check When Running on Kubernetes" + } ] } ] }, - "backup-restore", - "scalar-kubernetes/HowToScaleScalarDL", - "scalar-kubernetes/HowToUpgradeScalarDL", - "scalar-manager/overview" + { + "type": "doc", + "id": "backup-restore", + "label": "Backup and Restore Data" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToScaleScalarDL", + "label": "Scale" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToUpgradeScalarDL", + "label": "Upgrade" + }, + { + "type": "doc", + "id": "scalar-manager/overview", + "label": "Scalar Manager Overview" + } ] }, { @@ -231,9 +527,21 @@ "label": "Reference", "collapsible": true, "items": [ - "compatibility", - "scalardl-command-reference", - "scalardl-benchmarks/README" + { + "type": "doc", + "id": "compatibility", + "label": "Compatibility Matrix" + }, + { + "type": "doc", + "id": "scalardl-command-reference", + "label": "Client Commands" + }, + { + "type": "doc", + "id": "scalardl-benchmarks/README", + "label": "Run Benchmarks" + } ] }, { @@ -241,8 +549,575 @@ "label": "Releases", "collapsible": true, "items": [ - "releases/release-notes", - "releases/release-support-policy" + { + "type": "doc", + "id": "releases/release-notes", + "label": "Release Notes" + }, + { + "type": "doc", + "id": "releases/release-support-policy", + "label": "Release Support Policy" + } + ] + } + ], + + "docsJapanese": [ + { + "type": "doc", + "label": "ScalarDL ドキュメンテーションホーム", + "id": "index" + }, + { + "type": "category", + "label": "ScalarDL について", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "overview", + "label": "概要" + }, + { + "type": "doc", + "id": "design", + "label": "デザイン" + }, + { + "type": "doc", + "id": "implementation", + "label": "実装" + }, + { + "type": "doc", + "id": "requirements", + "label": "要件" + }, + { + "type": "doc", + "id": "roadmap", + "label": "ロードマップ" + } + ] + }, + { + "type": "category", + "label": "はじめよう", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "getting-started", + "label": "ScalarDL Ledger を通じてコントラクトを実行" + }, + { + "type": "doc", + "id": "getting-started-auditor", + "label": "ScalarDL Ledger と Auditor を通じてコントラクトを実行" + } + ] + }, + { + "type": "category", + "label": "サンプル", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "applications/simple-bank-account/README", + "label": "銀行口座アプリケーション" + } + ] + }, + { + "type": "category", + "label": "開発", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "SDKs", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardl-java-client-sdk/README", + "label": "ScalarDL Java Client SDK" + } + ] + }, + { + "type": "doc", + "id": "configurations", + "label": "の設定" + }, + { + "type": "doc", + "id": "schema-loader", + "label": "ScalarDL Schema Loader" + }, + { + "type": "doc", + "id": "ca/caclient-getting-started", + "label": "証明書を取得" + }, + { + "type": "doc", + "id": "authentication", + "label": "認証" + }, + { + "type": "doc", + "id": "how-to-handle-errors", + "label": "エラーハンドリング" + }, + { + "type": "doc", + "id": "how-to-write-contract", + "label": "コントラクトを作成" + }, + { + "type": "doc", + "id": "how-to-write-function", + "label": "ファンクションを作成" + }, + { + "type": "doc", + "id": "how-to-use-proof", + "label": "アセットプルーフを使用" + } + ] + }, + { + "type": "category", + "label": "デプロイ", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "Scalar Kubernetes", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "データベースセットアップガイド", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/SetupDatabaseForAWS", + "label": "AWS が提供するデータベース" + }, + { + "type": "doc", + "id": "scalar-kubernetes/SetupDatabaseForAzure", + "label": "Azure が提供するデータベース" + } + ] + }, + { + "type": "category", + "label": "インストールガイド", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/ProductionChecklistForScalarDLLedger", + "label": "ScalarDL Ledger の本番環境チェックリスト" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ProductionChecklistForScalarDLAuditor", + "label": "ScalarDL Auditor の本番環境チェックリスト" + }, + { + "type": "doc", + "id": "scalar-kubernetes/AwsMarketplaceGuide", + "label": "AWS Marketplace からインストール" + }, + { + "type": "doc", + "id": "scalar-kubernetes/AzureMarketplaceGuide", + "label": "Azure Marketplace からインストール" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateBastionServer", + "label": "踏み台サーバーを作成" + } + ] + }, + { + "type": "category", + "label": "クラスターガイド", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/CreateEKSClusterForScalarDL", + "label": "ScalarDL Ledger 用の EKS クラスターを作成" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateEKSClusterForScalarDLAuditor", + "label": "ScalarDL Ledger と Auditor 用の EKS クラスターを作成" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateAKSClusterForScalarDL", + "label": "ScalarDL Ledger 用の AKS クラスターを作成" + }, + { + "type": "doc", + "id": "scalar-kubernetes/CreateAKSClusterForScalarDLAuditor", + "label": "ScalarDL Ledger と Auditor 用の AKS クラスターを作成" + } + ] + }, + { + "type": "category", + "label": "コンテナイメージガイド", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/HowToGetContainerImages", + "label": "コンテナイメージを取得" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToUseContainerImages", + "label": "コンテナイメージを使用" + } + ] + }, + { + "type": "category", + "label": "デプロイメントガイド", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLOnEKS", + "label": "Amazon EKS に ScalarDL Ledger をデプロイ" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnEKS", + "label": "Amazon EKS に ScalarDL Ledger と Auditorをデプロイ" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLOnAKS", + "label": "AKS に ScalarDL Ledger をデプロイ" + }, + { + "type": "doc", + "id": "scalar-kubernetes/ManualDeploymentGuideScalarDLAuditorOnAKS", + "label": "AKS に ScalarDL Ledger と Auditor をデプロイ" + } + ] + }, + { + "type": "category", + "label": "設定のガイド", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/AccessScalarProducts", + "label": "アプリケーションから Kubernetes 環境にアクセス" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToCreateKeyAndCertificateFiles", + "label": "秘密鍵と証明書ファイルを作成" + }, + { + "type": "doc", + "id": "scalar-kubernetes/NetworkPeeringForScalarDLAuditor", + "label": "ネットワークピアリングを構成" + } + ] + } + ] + }, + { + "type": "category", + "label": "Scalar Helm Charts", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "はじめよう", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "helm-charts/getting-started-scalar-helm-charts", + "label": "Scalar Helm Charts をはじめよう" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-ledger", + "label": "Helm Chart を使用した ScalarDL Ledger" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-auditor", + "label": "Helm Chart を使用した ScalarDL Ledger と Auditor" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-auditor-tls", + "label": "Helm Chart を使用した TLS 対応 ScalarDL Ledger と Auditor" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalardl-auditor-tls-cert-manager", + "label": "cert-manager と Helm Chart を使用した TLS 対応 ScalarDL Ledger と Auditor" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-monitoring", + "label": "Helm Chart を使用した監視用 Prometheus Operator" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-logging", + "label": "Helm Chart を使用したログ記録用 Loki スタック" + }, + { + "type": "doc", + "id": "helm-charts/getting-started-scalar-manager", + "label": "Helm Chart を使用した Scalar Manager" + } + ] + }, + { + "type": "category", + "label": "カスタム値を設定", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalardl-ledger", + "label": "ScalarDL Ledger のカスタム値ファイルを構成" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalardl-auditor", + "label": "ScalarDL Auditor のカスタム値ファイルを構成" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalardl-schema-loader", + "label": "ScalarDL Schema Loader のカスタム値ファイルを構成" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalar-admin-for-kubernetes", + "label": "Scalar Admin for Kubernetes のカスタム値ファイルを構成" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-scalar-manager", + "label": "Scalar Manager のカスタム値ファイルを構成" + }, + { + "type": "doc", + "id": "helm-charts/configure-custom-values-envoy", + "label": "Scalar Envoy のカスタム値ファイルを構成" + } + ] + }, + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalar-products", + "label": "Helm Chart を使用して Scalar 製品をデプロイ" + }, + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalardl-ledger", + "label": "Helm Chart を使用して ScalarDL Ledger をデプロイ" + }, + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalardl-auditor", + "label": "Helm Chart を使用して ScalarDL Auditor をデプロイ" + }, + { + "type": "doc", + "id": "helm-charts/how-to-deploy-scalar-admin-for-kubernetes", + "label": "Helm Chart を使用して Scalar Admin for Kubernetes をデプロイ" + }, + { + "type": "doc", + "id": "helm-charts/mount-files-or-volumes-on-scalar-pods", + "label": "ScalarDL ポッドにファイルまたはボリュームをマウント" + }, + { + "type": "doc", + "id": "helm-charts/use-secret-for-credentials", + "label": "シークレットリソースを使用" + } + ] + }, + { + "type": "doc", + "id": "scalar-licensing/README", + "label": "製品ライセンスキーの設定" + }, + { + "type": "doc", + "id": "installation-with-docker", + "label": "Docker を使ってローカル環境に ScalarDL をインストール" + }, + { + "type": "doc", + "id": "ca/caserver-getting-started", + "label": "CFSSL で CA サーバーを起動" + } + ] + }, + { + "type": "category", + "label": "運用", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "Scalar Kubernetes", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "モニタリングガイド", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "アラート", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/alerts/Envoy", + "label": "Envoy アラート" + }, + { + "type": "doc", + "id": "scalar-kubernetes/alerts/Ledger", + "label": "Ledger アラート" + } + ] + }, + { + "type": "doc", + "id": "scalar-kubernetes/K8sMonitorGuide", + "label": "Kubernetes モニタリングガイド" + }, + { + "type": "doc", + "id": "scalar-kubernetes/K8sLogCollectionGuide", + "label": "Kubernetes ログ収集ガイド" + } + ] + }, + { + "type": "category", + "label": "バックアップと復元のガイド", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalar-kubernetes/BackupRestoreGuide", + "label": "Kubernetes 環境で ScalarDL データをバックアップおよび復元" + }, + { + "type": "doc", + "id": "scalar-kubernetes/BackupRDB", + "label": "Kubernetes 環境で RDB をバックアップ" + }, + { + "type": "doc", + "id": "scalar-kubernetes/BackupNoSQL", + "label": "Kubernetes 環境で NoSQL データベースをバックアップ" + }, + { + "type": "doc", + "id": "scalar-kubernetes/RestoreDatabase", + "label": "Kubernetes 環境でデータベースを復元" + }, + { + "type": "doc", + "id": "scalar-kubernetes/RegularCheck", + "label": "Kubernetes 環境で実行するときに定期的にチェックするコンポーネント" + } + ] + } + ] + }, + { + "type": "doc", + "id": "backup-restore", + "label": "データのバックアップと復元" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToScaleScalarDL", + "label": "スケーリング" + }, + { + "type": "doc", + "id": "scalar-kubernetes/HowToUpgradeScalarDL", + "label": "アップグレード" + }, + { + "type": "doc", + "id": "scalar-manager/overview", + "label": "Scalar Manager の概要" + } + ] + }, + { + "type": "category", + "label": "詳細", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "compatibility", + "label": "互換性マトリックス" + }, + { + "type": "doc", + "id": "scalardl-command-reference", + "label": "クライアントコマンドリファレンス" + }, + { + "type": "doc", + "id": "scalardl-benchmarks/README", + "label": "ベンチマークを実行" + } + ] + }, + { + "type": "category", + "label": "リリース", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "releases/release-notes", + "label": "リリースノート" + }, + { + "type": "doc", + "id": "releases/release-support-policy", + "label": "リリースサポートポリシー" + } ] } ]