Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Re-organize sidebar navigation #138

Merged
merged 13 commits into from
Aug 14, 2024
Merged

Re-organize sidebar navigation #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
29d431a
Reorganize sidebar navigation
josh-wong Aug 2, 2024
6d0b924
Merge branch 'main' into reorganize-sidebar-navigation
josh-wong Aug 7, 2024
f730c7e
Add index for backup and restore
josh-wong Aug 8, 2024
3db0e43
Merge branch 'main' into reorganize-sidebar-navigation
josh-wong Aug 8, 2024
5161a37
Remove unnecessary doc
josh-wong Aug 8, 2024
0a74a26
Update sidebar navigation
josh-wong Aug 8, 2024
d44ed83
Merge branch 'main' into reorganize-sidebar-navigation
josh-wong Aug 8, 2024
430d50f
Make minor revisions to wording
josh-wong Aug 8, 2024
2f3dc05
Merge branch 'main' into reorganize-sidebar-navigation
josh-wong Aug 13, 2024
018aeed
Add redirect for storage abstraction doc
josh-wong Aug 13, 2024
c895d72
Replace placeholders with new docs
josh-wong Aug 13, 2024
af83c7c
Comment out redirect for later use
josh-wong Aug 13, 2024
9ab0f52
Change link wording
josh-wong Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions docs/manage-backup-and-restore.mdx
View file
Open in desktop

This file was deleted.

13 changes: 13 additions & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,19 @@ const config = {
to: '/docs/latest',
from: ['/', '/docs'],
},
{
to: '/docs/latest/run-non-transactional-storage-operations-through-primitive-crud-interface',
from: '/docs/latest/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',
},
],
},
],
Expand Down
273 changes: 226 additions & 47 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,103 +29,282 @@ 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 Running Transactions Through the ScalarDB Core Library',
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 Running Analytical Queries Through 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',
],
},
{
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: 'Model Your Data',
},
{
type: 'category',
label: 'Run Through the CRUD Interface',
collapsible: true,
items: [
{ // To be created
type: 'doc',
id: 'run-transactions-through-scalardb-core-library',
label: 'Use the ScalarDB Core 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: 'Run ScalarDB Analytics with PostgreSQL',
},
],
},
{
type: 'category',
label: 'Run Non-Transactional Storage Operations',
collapsible: true,
items: [
{
type: 'category',
label: 'Run Through the CRUD Interface',
collapsible: true,
items: [
{ // To be created
type: 'doc',
id: 'run-non-transactional-storage-operations-through-library',
label: 'Use the ScalarDB Core Library',
},
],
},
{
type: 'doc',
id: 'run-non-transactional-storage-operations-through-primitive-crud-interface',
label: 'Run Through the Primitive CRUD Interface',
},
],
},
{
type: 'category',
label: 'Developer Guides',
label: 'Create Sample Applications',
collapsible: true,
items: [
'api-guide',
{
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: 'Configuration Guides',
label: 'Reference',
collapsible: true,
items: [
'configurations',
'multi-storage-transactions',
'two-phase-commit-transactions',
{
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',
{
type: 'doc',
id: 'schema-loader-import',
label: 'Import Existing Tables',
},
],
},
{
type: 'category',
label: 'Manage',
collapsible: true,
items: [
'backup-restore',
],
},
{
type: 'category',
label: 'Reference',
collapsible: true,
items: [
'scalardb-benchmarks/README',
'storage-abstraction',
'scalardb-core-status-codes',
{
type: 'doc',
id: 'backup-restore',
label: 'Back Up and Restore Databases Used Through ScalarDB',
},
],
},
{
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',
},
],
},
],
},
],
Expand Down
15 changes: 0 additions & 15 deletions versioned_docs/version-3.12/manage-backup-and-restore.mdx
View file
Open in desktop

This file was deleted.

Loading