From 29d431a34d5118d9dad6b4e6062410333b7c3d83 Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Fri, 2 Aug 2024 11:43:52 +0900 Subject: [PATCH 1/9] Reorganize sidebar navigation --- sidebars.js | 322 +++++++++++++++--- versioned_sidebars/version-3.12-sidebars.json | 287 +++++++++++++--- 2 files changed, 515 insertions(+), 94 deletions(-) diff --git a/sidebars.js b/sidebars.js index 6642871..ec1d2a5 100644 --- a/sidebars.js +++ b/sidebars.js @@ -29,38 +29,84 @@ const sidebars = { label: 'About ScalarDB', collapsible: true, items: [ - 'overview', - 'design', - 'requirements', - 'scalardb-supported-databases', - 'database-configurations', + { + type: 'doc', + id: 'overview', + label: 'Overview', + }, + { + type: 'doc', + id: 'design', + label: 'Design', + }, + { + type: 'doc', + id: 'scalardb-supported-databases', + label: 'Supported Databases', + }, + { + type: 'doc', + id: 'requirements', + label: 'Requirements', + }, + { + type: 'doc', + id: 'releases/release-notes', + label: 'Release Notes', + }, ], }, { type: 'category', - label: 'Getting Started', + label: 'Quickstart', collapsible: true, items: [ + { + type: 'doc', + id: 'quick-start-overview', + label: 'Overview', + }, { type: 'category', - label: 'ScalarDB', + label: 'Try ScalarDB Core Transactions', collapsible: true, items: [ - 'getting-started-with-scalardb', - 'getting-started-with-scalardb-by-using-kotlin', - 'scalardb-analytics-postgresql/getting-started', + { + type: 'doc', + id: 'getting-started-with-scalardb', + label: 'Use ScalarDB Core', + }, + { + type: 'doc', + id: 'getting-started-with-scalardb-by-using-kotlin', + label: 'Use Kotlin', + }, + ], + }, + { + type: 'category', + label: 'Try ScalarDB Analytics', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-analytics-postgresql/getting-started', + label: 'Use ScalarDB Analytics with PostgreSQL', + }, + ], + }, + { + type: 'category', + label: 'Reference', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-analytics-postgresql/installation', + label: 'Install ScalarDB Analytics with PostgreSQL Locally', + }, ], }, - ], - }, - { - type: 'category', - label: 'Samples', - collapsible: true, - items: [ - 'scalardb-samples/multi-storage-transaction-sample/README', - 'scalardb-samples/microservice-transaction-sample/README', - 'scalardb-samples/scalardb-analytics-postgresql-sample/README', ], }, { @@ -68,38 +114,191 @@ const sidebars = { label: 'Develop', collapsible: true, items: [ + { + type: 'doc', + id: 'develop-overview', + label: 'Overview', + }, + { + type: 'category', + label: 'Run Transactions', + collapsible: true, + items: [ + { + type: 'doc', + id: 'data-modeling', + label: 'Data Modeling', + }, + { + type: 'category', + label: 'Run Through the CRUD Interface', + collapsible: true, + items: [ + { // THIS LINK IS ONLY FOR RENDERING THE SIDEBAR. REMOVE THIS ITEM WHEN THE COMMENTED OUT DOC HAS BEEN CREATED. + type: 'doc', + id: 'overview', + label: 'PLACEHOLDER', + }, + // { To be created + // type: 'doc', + // id: 'run-transactions-through-scalardb-library', + // label: 'Use the Library', + // }, + ], + }, + { + type: 'category', + label: 'Advanced Configurations and Operations', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-benchmarks/README', + label: 'Run Benchmarks', + }, + ], + }, + ], + }, + { + type: 'category', + label: 'Run Analytical Queries', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-samples/scalardb-analytics-postgresql-sample/README', + label: 'Use ScalarDB Analytics with PostgreSQL', + }, + ], + }, { type: 'category', - label: 'Developer Guides', + label: 'Run Non-Transactional Storage Operations', collapsible: true, items: [ - 'api-guide', + { + type: 'category', + label: 'Run Through the CRUD Interface', + collapsible: true, + items: [ + { // THIS LINK IS ONLY FOR RENDERING THE SIDEBAR. REMOVE THIS ITEM WHEN THE COMMENTED OUT DOC HAS BEEN CREATED. + type: 'doc', + id: 'overview', + label: 'PLACEHOLDER', + }, + // { To be created + // type: 'doc', + // id: 'run-non-transactional-operations-through-scalardb-library', + // label: 'Use the Library', + // }, + // { To be created + // type: 'doc', + // id: 'run-non-transactional-operations-through-scalardb-cluster', + // label: 'Use ScalarDB Cluster', + // }, + ], + }, + // { To be created + // type: 'doc', + // id: 'run-non-transactional-operations-through-sql-interface', + // label: 'Use the SQL Interface', + // }, + { + type: 'doc', + id: 'storage-abstraction', + label: 'Run Through the Primitive CRUD Interface', + }, ], }, { type: 'category', - label: 'Configuration Guides', + label: 'Create Sample Applications', collapsible: true, items: [ - 'configurations', - 'multi-storage-transactions', - 'two-phase-commit-transactions', + { + type: 'doc', + id: 'scalardb-samples/multi-storage-transaction-sample/README', + label: 'Multi-Storage Transactions', + }, + { + type: 'doc', + id: 'scalardb-samples/microservice-transaction-sample/README', + label: 'Microservice Transactions', + }, + ], + }, + { + type: 'category', + label: 'Reference', + collapsible: true, + items: [ + { + type: 'doc', + id: 'add-scalardb-to-your-build', + label: 'Add ScalarDB to Your Build', + }, + { + type: 'doc', + id: 'configurations', + label: 'ScalarDB Configurations', + }, + { + type: 'doc', + id: 'api-guide', + label: 'API Guide', + }, + { + type: 'doc', + id: 'two-phase-commit-transactions', + label: 'Two-Phase Commit Transactions', + }, + { + type: 'doc', + id: 'multi-storage-transactions', + label: 'Multi-Storage Transactions', + }, + { + type: 'doc', + id: 'schema-loader', + label: 'Schema Loader', + }, + { + type: 'category', + label: 'Analytics', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-analytics-postgresql/scalardb-fdw', + label: 'ScalarDB FDW for PostgreSQL', + }, + { + type: 'doc', + id: 'scalardb-analytics-postgresql/schema-importer', + label: 'PostgreSQL Schema Importer for PostgreSQL', + }, + ], + }, ], }, - 'data-modeling', - 'add-scalardb-to-your-build', - 'schema-loader', - 'schema-loader-import', - 'scalardb-analytics-postgresql/scalardb-fdw', - 'scalardb-analytics-postgresql/schema-importer', ], }, { type: 'category', - label: 'Deploy', + label: 'Migrate', collapsible: true, items: [ - 'scalardb-analytics-postgresql/installation', + // { To be created + // type: 'doc', + // id: 'migrate-overview', + // label: 'Overview', + // }, + { + type: 'doc', + id: 'schema-loader-import', + label: 'Import Existing Tables', + }, ], }, { @@ -107,25 +306,54 @@ const sidebars = { label: 'Manage', collapsible: true, items: [ - 'backup-restore', - ], - }, - { - type: 'category', - label: 'Reference', - collapsible: true, - items: [ - 'scalardb-benchmarks/README', - 'storage-abstraction', - 'scalardb-core-status-codes', + // { To be created + // type: 'doc', + // id: 'manage-overview', + // label: 'Overview', + // }, + { + type: 'category', + label: 'Back Up and Restore', + collapsible: true, + items: [ + // { To be created + // type: 'doc', + // id: 'manage-backup-and-restore', + // label: 'Back Up and Restore Databases', + // }, + { + type: 'category', + label: 'Reference', + collapsible: true, + items: [ + { + type: 'doc', + id: 'backup-restore', + label: 'Back Up and Restore Databases', + }, + ], + }, + ], + }, ], }, { type: 'category', - label: 'Releases', + label: 'Troubleshoot', collapsible: true, items: [ - 'releases/release-notes', + { + type: 'category', + label: 'Error Codes', + collapsible: true, + items: [ + { + type: 'doc', + id: 'scalardb-core-status-codes', + label: 'ScalarDB', + }, + ], + }, ], }, ], diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index bdf1f7f..5c2395f 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -10,77 +10,251 @@ "label": "About ScalarDB", "collapsible": true, "items": [ - "overview", - "design", - "requirements", - "scalardb-supported-databases", - "database-configurations" + { + "type": "doc", + "id": "overview", + "label": "Overview" + }, + { + "type": "doc", + "id": "design", + "label": "Design" + }, + { + "type": "doc", + "id": "scalardb-supported-databases", + "label": "Supported Databases" + }, + { + "type": "doc", + "id": "requirements", + "label": "Requirements" + }, + { + "type": "doc", + "id": "releases/release-notes", + "label": "Release Notes" + } ] }, { "type": "category", - "label": "Getting Started", + "label": "Quickstart", "collapsible": true, "items": [ + { + "type": "doc", + "id": "quick-start-overview", + "label": "Overview" + }, + { + "type": "category", + "label": "Try ScalarDB Core Transactions", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "getting-started-with-scalardb", + "label": "Use ScalarDB Core" + }, + { + "type": "doc", + "id": "getting-started-with-scalardb-by-using-kotlin", + "label": "Use Kotlin" + } + ] + }, { "type": "category", - "label": "ScalarDB", + "label": "Try ScalarDB Analytics", "collapsible": true, "items": [ - "getting-started-with-scalardb", - "getting-started-with-scalardb-by-using-kotlin", - "scalardb-analytics-postgresql/getting-started" + { + "type": "doc", + "id": "scalardb-analytics-postgresql/getting-started", + "label": "Use ScalarDB Analytics with PostgreSQL" + } + ] + }, + { + "type": "category", + "label": "Reference", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-analytics-postgresql/installation", + "label": "Install ScalarDB Analytics with PostgreSQL Locally" + } ] } ] }, - { - "type": "category", - "label": "Samples", - "collapsible": true, - "items": [ - "scalardb-samples/multi-storage-transaction-sample/README", - "scalardb-samples/microservice-transaction-sample/README", - "scalardb-samples/scalardb-analytics-postgresql-sample/README" - ] - }, { "type": "category", "label": "Develop", "collapsible": true, "items": [ + { + "type": "doc", + "id": "develop-overview", + "label": "Overview" + }, + { + "type": "category", + "label": "Run Transactions", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "data-modeling", + "label": "Data Modeling" + }, + { + "type": "category", + "label": "Run Through the CRUD Interface", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "overview", + "label": "PLACEHOLDER" + } + ] + }, + { + "type": "category", + "label": "Advanced Configurations and Operations", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-benchmarks/README", + "label": "Run Benchmarks" + } + ] + } + ] + }, + { + "type": "category", + "label": "Run Analytical Queries", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-samples/scalardb-analytics-postgresql-sample/README", + "label": "Use ScalarDB Analytics with PostgreSQL" + } + ] + }, { "type": "category", - "label": "Developer Guides", + "label": "Run Non-Transactional Storage Operations", "collapsible": true, "items": [ - "api-guide" + { + "type": "category", + "label": "Run Through the CRUD Interface", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "overview", + "label": "PLACEHOLDER" + } + ] + }, + { + "type": "doc", + "id": "storage-abstraction", + "label": "Run Through the Primitive CRUD Interface" + } ] }, { "type": "category", - "label": "Configuration Guides", + "label": "Create Sample Applications", "collapsible": true, "items": [ - "configurations", - "multi-storage-transactions", - "two-phase-commit-transactions" + { + "type": "doc", + "id": "scalardb-samples/multi-storage-transaction-sample/README", + "label": "Multi-Storage Transactions" + }, + { + "type": "doc", + "id": "scalardb-samples/microservice-transaction-sample/README", + "label": "Microservice Transactions" + } ] }, - "data-modeling", - "add-scalardb-to-your-build", - "schema-loader", - "schema-loader-import", - "scalardb-analytics-postgresql/scalardb-fdw", - "scalardb-analytics-postgresql/schema-importer" + { + "type": "category", + "label": "Reference", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "add-scalardb-to-your-build", + "label": "Add ScalarDB to Your Build" + }, + { + "type": "doc", + "id": "configurations", + "label": "ScalarDB Configurations" + }, + { + "type": "doc", + "id": "api-guide", + "label": "API Guide" + }, + { + "type": "doc", + "id": "two-phase-commit-transactions", + "label": "Two-Phase Commit Transactions" + }, + { + "type": "doc", + "id": "multi-storage-transactions", + "label": "Multi-Storage Transactions" + }, + { + "type": "doc", + "id": "schema-loader", + "label": "Schema Loader" + }, + { + "type": "category", + "label": "Analytics", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-analytics-postgresql/scalardb-fdw", + "label": "ScalarDB FDW for PostgreSQL" + }, + { + "type": "doc", + "id": "scalardb-analytics-postgresql/schema-importer", + "label": "PostgreSQL Schema Importer for PostgreSQL" + } + ] + } + ] + } ] }, { "type": "category", - "label": "Deploy", + "label": "Migrate", "collapsible": true, "items": [ - "scalardb-analytics-postgresql/installation" + { + "type": "doc", + "id": "schema-loader-import", + "label": "Import Existing Tables" + } ] }, { @@ -88,25 +262,44 @@ "label": "Manage", "collapsible": true, "items": [ - "backup-restore" - ] - }, - { - "type": "category", - "label": "Reference", - "collapsible": true, - "items": [ - "scalardb-benchmarks/README", - "storage-abstraction", - "scalardb-core-status-codes" + { + "type": "category", + "label": "Back Up and Restore", + "collapsible": true, + "items": [ + { + "type": "category", + "label": "Reference", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "backup-restore", + "label": "Back Up and Restore Databases" + } + ] + } + ] + } ] }, { "type": "category", - "label": "Releases", + "label": "Troubleshoot", "collapsible": true, "items": [ - "releases/release-notes" + { + "type": "category", + "label": "Error Codes", + "collapsible": true, + "items": [ + { + "type": "doc", + "id": "scalardb-core-status-codes", + "label": "ScalarDB" + } + ] + } ] } ] From f730c7ea330757c138bbfc940907fe9291a6698f Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 8 Aug 2024 14:15:48 +0900 Subject: [PATCH 2/9] Add index for backup and restore --- sidebars.js | 10 +++++----- versioned_sidebars/version-3.12-sidebars.json | 5 +++++ 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/sidebars.js b/sidebars.js index ec1d2a5..9ff9e13 100644 --- a/sidebars.js +++ b/sidebars.js @@ -316,11 +316,11 @@ const sidebars = { label: 'Back Up and Restore', collapsible: true, items: [ - // { To be created - // type: 'doc', - // id: 'manage-backup-and-restore', - // label: 'Back Up and Restore Databases', - // }, + { + type: 'doc', + id: 'manage-backup-and-restore', + label: 'Back Up and Restore Databases', + }, { type: 'category', label: 'Reference', diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index 5c2395f..18aaa3f 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -267,6 +267,11 @@ "label": "Back Up and Restore", "collapsible": true, "items": [ + { + "type": "doc", + "id": "manage-backup-and-restore", + "label": "Back Up and Restore Databases" + }, { "type": "category", "label": "Reference", From 5161a378698c2b6cb98c81ddb42f597edad035eb Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 8 Aug 2024 15:26:02 +0900 Subject: [PATCH 3/9] Remove unnecessary doc This doc include details specifically for the Enterprise version, so don't need it in the Community version. --- docs/manage-backup-and-restore.mdx | 15 --------------- .../version-3.12/manage-backup-and-restore.mdx | 15 --------------- 2 files changed, 30 deletions(-) delete mode 100644 docs/manage-backup-and-restore.mdx delete mode 100644 versioned_docs/version-3.12/manage-backup-and-restore.mdx diff --git a/docs/manage-backup-and-restore.mdx b/docs/manage-backup-and-restore.mdx deleted file mode 100644 index b2f82b6..0000000 --- a/docs/manage-backup-and-restore.mdx +++ /dev/null @@ -1,15 +0,0 @@ -# Back Up and Restore Databases - -This guide explains how to back up and restore databases that are used by ScalarDB. - -## Basic guidelines to back up and restore databases - -Before performing a backup, be sure to read [How to Back Up and Restore Databases Used Through ScalarDB](backup-restore.mdx). - -## Back up databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Back up a NoSQL database in a Kubernetes environment](scalar-kubernetes/BackupNoSQL.mdx). - -## Restore databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Restore databases in a Kubernetes environment](scalar-kubernetes/RestoreDatabase.mdx). diff --git a/versioned_docs/version-3.12/manage-backup-and-restore.mdx b/versioned_docs/version-3.12/manage-backup-and-restore.mdx deleted file mode 100644 index b2f82b6..0000000 --- a/versioned_docs/version-3.12/manage-backup-and-restore.mdx +++ /dev/null @@ -1,15 +0,0 @@ -# Back Up and Restore Databases - -This guide explains how to back up and restore databases that are used by ScalarDB. - -## Basic guidelines to back up and restore databases - -Before performing a backup, be sure to read [How to Back Up and Restore Databases Used Through ScalarDB](backup-restore.mdx). - -## Back up databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Back up a NoSQL database in a Kubernetes environment](scalar-kubernetes/BackupNoSQL.mdx). - -## Restore databases when using ScalarDB in a Kubernetes environment - -For details on how to restore databases in a Kubernetes environment, see [Restore databases in a Kubernetes environment](scalar-kubernetes/RestoreDatabase.mdx). From 0a74a2606041b13fdfa4d025d520ac79cfc86a33 Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 8 Aug 2024 15:28:29 +0900 Subject: [PATCH 4/9] Update sidebar navigation --- sidebars.js | 75 ++++--------------- versioned_sidebars/version-3.12-sidebars.json | 47 ++++-------- 2 files changed, 27 insertions(+), 95 deletions(-) diff --git a/sidebars.js b/sidebars.js index 9ff9e13..19f9932 100644 --- a/sidebars.js +++ b/sidebars.js @@ -68,7 +68,7 @@ const sidebars = { }, { type: 'category', - label: 'Try ScalarDB Core Transactions', + label: 'Try Running Transactions Through the ScalarDB Core Library', collapsible: true, items: [ { @@ -85,7 +85,7 @@ const sidebars = { }, { type: 'category', - label: 'Try ScalarDB Analytics', + label: 'Try Running Analytical Queries Through ScalarDB Analytics', collapsible: true, items: [ { @@ -134,16 +134,11 @@ const sidebars = { label: 'Run Through the CRUD Interface', collapsible: true, items: [ - { // THIS LINK IS ONLY FOR RENDERING THE SIDEBAR. REMOVE THIS ITEM WHEN THE COMMENTED OUT DOC HAS BEEN CREATED. + { // To be created type: 'doc', - id: 'overview', - label: 'PLACEHOLDER', + id: 'index', + label: 'Use the ScalarDB Core Library (PLACEHOLDER)', }, - // { To be created - // type: 'doc', - // id: 'run-transactions-through-scalardb-library', - // label: 'Use the Library', - // }, ], }, { @@ -182,32 +177,17 @@ const sidebars = { label: 'Run Through the CRUD Interface', collapsible: true, items: [ - { // THIS LINK IS ONLY FOR RENDERING THE SIDEBAR. REMOVE THIS ITEM WHEN THE COMMENTED OUT DOC HAS BEEN CREATED. + { // To be created type: 'doc', - id: 'overview', - label: 'PLACEHOLDER', + id: 'index', + label: 'Use the ScalarDB Core Library (PLACEHOLDER)', }, - // { To be created - // type: 'doc', - // id: 'run-non-transactional-operations-through-scalardb-library', - // label: 'Use the Library', - // }, - // { To be created - // type: 'doc', - // id: 'run-non-transactional-operations-through-scalardb-cluster', - // label: 'Use ScalarDB Cluster', - // }, ], }, - // { To be created - // type: 'doc', - // id: 'run-non-transactional-operations-through-sql-interface', - // label: 'Use the SQL Interface', - // }, { type: 'doc', - id: 'storage-abstraction', - label: 'Run Through the Primitive CRUD Interface', + id: 'index', + label: 'Run Through the Primitive CRUD Interface (PLACEHOLDER)', }, ], }, @@ -289,11 +269,6 @@ const sidebars = { label: 'Migrate', collapsible: true, items: [ - // { To be created - // type: 'doc', - // id: 'migrate-overview', - // label: 'Overview', - // }, { type: 'doc', id: 'schema-loader-import', @@ -306,34 +281,10 @@ const sidebars = { label: 'Manage', collapsible: true, items: [ - // { To be created - // type: 'doc', - // id: 'manage-overview', - // label: 'Overview', - // }, { - type: 'category', - label: 'Back Up and Restore', - collapsible: true, - items: [ - { - type: 'doc', - id: 'manage-backup-and-restore', - label: 'Back Up and Restore Databases', - }, - { - type: 'category', - label: 'Reference', - collapsible: true, - items: [ - { - type: 'doc', - id: 'backup-restore', - label: 'Back Up and Restore Databases', - }, - ], - }, - ], + type: 'doc', + id: 'backup-restore', + label: 'Back Up and Restore Databases Used Through ScalarDB', }, ], }, diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index b9dbc18..96c7166 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -49,7 +49,7 @@ }, { "type": "category", - "label": "Try ScalarDB Core Transactions", + "label": "Try Running Transactions Through the ScalarDB Core Library", "collapsible": true, "items": [ { @@ -66,7 +66,7 @@ }, { "type": "category", - "label": "Try ScalarDB Analytics", + "label": "Try Running Analytical Queries Through ScalarDB Analytics", "collapsible": true, "items": [ { @@ -117,8 +117,8 @@ "items": [ { "type": "doc", - "id": "overview", - "label": "PLACEHOLDER" + "id": "index", + "label": "Use the ScalarDB Core Library (PLACEHOLDER)" } ] }, @@ -160,18 +160,18 @@ "items": [ { "type": "doc", - "id": "overview", - "label": "PLACEHOLDER" + "id": "index", + "label": "Use the ScalarDB Core Library (PLACEHOLDER)" } ] - }, - { - "type": "doc", - "id": "storage-abstraction", - "label": "Run Through the Primitive CRUD Interface" } ] }, + { + "type": "doc", + "id": "index", + "label": "Run Through the Primitive CRUD Interface (PLACEHOLDER)" + }, { "type": "category", "label": "Create Sample Applications", @@ -263,28 +263,9 @@ "collapsible": true, "items": [ { - "type": "category", - "label": "Back Up and Restore", - "collapsible": true, - "items": [ - { - "type": "doc", - "id": "manage-backup-and-restore", - "label": "Back Up and Restore Databases" - }, - { - "type": "category", - "label": "Reference", - "collapsible": true, - "items": [ - { - "type": "doc", - "id": "backup-restore", - "label": "Back Up and Restore Databases" - } - ] - } - ] + "type": "doc", + "id": "backup-restore", + "label": "Back Up and Restore Databases Used Through ScalarDB" } ] }, From 430d50f2d65f86074a5d3ffbecdfb7e0bc55aa11 Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:23:12 +0900 Subject: [PATCH 5/9] Make minor revisions to wording --- sidebars.js | 2 +- versioned_sidebars/version-3.12-sidebars.json | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/sidebars.js b/sidebars.js index 19f9932..f866ead 100644 --- a/sidebars.js +++ b/sidebars.js @@ -127,7 +127,7 @@ const sidebars = { { type: 'doc', id: 'data-modeling', - label: 'Data Modeling', + label: 'Model Your Data', }, { type: 'category', diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index 96c7166..25b46cd 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -108,7 +108,7 @@ { "type": "doc", "id": "data-modeling", - "label": "Data Modeling" + "label": "Model Your Data" }, { "type": "category", @@ -164,14 +164,14 @@ "label": "Use the ScalarDB Core Library (PLACEHOLDER)" } ] + }, + { + "type": "doc", + "id": "index", + "label": "Run Through the Primitive CRUD Interface (PLACEHOLDER)" } ] }, - { - "type": "doc", - "id": "index", - "label": "Run Through the Primitive CRUD Interface (PLACEHOLDER)" - }, { "type": "category", "label": "Create Sample Applications", From 018aeed7f7322e33c21f08afe611ef1b2c324c33 Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Tue, 13 Aug 2024 12:11:16 +0900 Subject: [PATCH 6/9] Add redirect for storage abstraction doc Redirect applies to version 3.12 and 3.13 (latest). --- docusaurus.config.js | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docusaurus.config.js b/docusaurus.config.js index 9f12bf5..8f0dc61 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -153,6 +153,18 @@ const config = { to: '/docs/latest', from: ['/', '/docs'], }, + { + to: '/docs/latest/run-non-transactional-storage-operations-through-primitive-crud-interface', + from: '/docs/latest/storage-abstraction', + }, + { + to: '/docs/3.13/run-non-transactional-storage-operations-through-primitive-crud-interface', + from: '/docs/3.13/storage-abstraction', + }, + { + to: '/docs/3.12/run-non-transactional-storage-operations-through-primitive-crud-interface', + from: '/docs/3.12/storage-abstraction', + }, ], }, ], From c895d72789a128e8e66fa7b80c584e3bc62ebc4e Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Tue, 13 Aug 2024 12:31:21 +0900 Subject: [PATCH 7/9] Replace placeholders with new docs --- sidebars.js | 12 ++++++------ versioned_sidebars/version-3.12-sidebars.json | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/sidebars.js b/sidebars.js index f866ead..a5e2ae1 100644 --- a/sidebars.js +++ b/sidebars.js @@ -136,8 +136,8 @@ const sidebars = { items: [ { // To be created type: 'doc', - id: 'index', - label: 'Use the ScalarDB Core Library (PLACEHOLDER)', + id: 'run-transactions-through-scalardb-core-library', + label: 'Use the ScalarDB Core Library', }, ], }, @@ -179,15 +179,15 @@ const sidebars = { items: [ { // To be created type: 'doc', - id: 'index', - label: 'Use the ScalarDB Core Library (PLACEHOLDER)', + id: 'run-non-transactional-storage-operations-through-library', + label: 'Use the ScalarDB Core Library', }, ], }, { type: 'doc', - id: 'index', - label: 'Run Through the Primitive CRUD Interface (PLACEHOLDER)', + id: 'run-non-transactional-storage-operations-through-primitive-crud-interface', + label: 'Run Through the Primitive CRUD Interface', }, ], }, diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index 25b46cd..f8e5e7d 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -117,8 +117,8 @@ "items": [ { "type": "doc", - "id": "index", - "label": "Use the ScalarDB Core Library (PLACEHOLDER)" + "id": "run-transactions-through-scalardb-core-library", + "label": "Use the ScalarDB Core Library" } ] }, @@ -160,15 +160,15 @@ "items": [ { "type": "doc", - "id": "index", - "label": "Use the ScalarDB Core Library (PLACEHOLDER)" + "id": "run-non-transactional-storage-operations-through-library", + "label": "Use the ScalarDB Core Library" } ] }, { "type": "doc", - "id": "index", - "label": "Run Through the Primitive CRUD Interface (PLACEHOLDER)" + "id": "run-non-transactional-storage-operations-through-primitive-crud-interface", + "label": "Run Through the Primitive CRUD Interface" } ] }, From af83c7cd82b9e8ad69dbda9ad973a4d5de288d27 Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Tue, 13 Aug 2024 12:44:17 +0900 Subject: [PATCH 8/9] Comment out redirect for later use --- docusaurus.config.js | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 8f0dc61..c3009c8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -157,10 +157,11 @@ const config = { to: '/docs/latest/run-non-transactional-storage-operations-through-primitive-crud-interface', from: '/docs/latest/storage-abstraction', }, - { - to: '/docs/3.13/run-non-transactional-storage-operations-through-primitive-crud-interface', - from: '/docs/3.13/storage-abstraction', - }, + // Uncomment this line when the docs for 3.14 are released. + // { + // to: '/docs/3.13/run-non-transactional-storage-operations-through-primitive-crud-interface', + // from: '/docs/3.13/storage-abstraction', + // }, { to: '/docs/3.12/run-non-transactional-storage-operations-through-primitive-crud-interface', from: '/docs/3.12/storage-abstraction', From 9ab0f52ff1e2292fe4a6a52cfb0338cb97884763 Mon Sep 17 00:00:00 2001 From: josh-wong <23216828+josh-wong@users.noreply.github.com> Date: Tue, 13 Aug 2024 18:29:22 +0900 Subject: [PATCH 9/9] Change link wording --- sidebars.js | 2 +- versioned_sidebars/version-3.12-sidebars.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sidebars.js b/sidebars.js index a5e2ae1..8d5383c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -163,7 +163,7 @@ const sidebars = { { type: 'doc', id: 'scalardb-samples/scalardb-analytics-postgresql-sample/README', - label: 'Use ScalarDB Analytics with PostgreSQL', + label: 'Run ScalarDB Analytics with PostgreSQL', }, ], }, diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index f8e5e7d..a79ad39 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -72,7 +72,7 @@ { "type": "doc", "id": "scalardb-analytics-postgresql/getting-started", - "label": "Use ScalarDB Analytics with PostgreSQL" + "label": "Run ScalarDB Analytics with PostgreSQL" } ] },