corso/website/sidebars.js
Niraj Tolia 18843ac1e2
Group CLI docs by service for better accessibility (#2890)
This commit makes the CLI docs more accessible by grouping them by service

---

#### Does this PR need a docs update or release note?

- [x]  Yes, it's included

#### Type of change

- [x] 🗺️ Documentation
2023-03-21 07:56:25 +00:00

107 lines
3.1 KiB
JavaScript

/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
docsSidebar: [
'intro',
'quickstart',
{
type: 'category',
label: 'Usage',
items: ['setup/concepts', 'setup/download', 'setup/m365-access', 'setup/configuration', 'setup/repos', 'setup/fault-tolerance'],
},
{
type: 'category',
label: 'Command line reference',
link: {
slug: 'cli/corso',
description: 'Explore the commonly-used Corso CLI commands',
type: 'generated-index',
},
items: [
{
type: 'category',
label: 'Setup',
link: {
slug: 'cli/setup',
description: 'Documentation for commonly-used Corso setup CLI commands',
},
items: [
'cli/corso-repo-init-s3',
'cli/corso-repo-connect-s3',
'cli/corso-env']
},
{
type: 'category',
label: 'Exchange',
link: {
slug: 'cli/exchange',
description: 'Documentation for commonly-used Corso Exchange CLI commands',
},
items: [
'cli/corso-backup-create-exchange',
'cli/corso-backup-list-exchange',
'cli/corso-backup-details-exchange',
'cli/corso-backup-delete-exchange',
'cli/corso-restore-exchange']
},
{
type: 'category',
label: 'OneDrive',
link: {
slug: 'cli/onedrive',
description: 'Documentation for commonly-used Corso OneDrive CLI commands',
},
items: [
'cli/corso-backup-create-onedrive',
'cli/corso-backup-list-onedrive',
'cli/corso-backup-details-onedrive',
'cli/corso-backup-delete-onedrive',
'cli/corso-restore-onedrive']
},
{
type: 'category',
label: 'SharePoint',
link: {
slug: 'cli/sharepoint',
description: 'Documentation for commonly-used Corso SharePoint CLI commands',
},
items: [
'cli/corso-backup-create-sharepoint',
'cli/corso-backup-list-sharepoint',
'cli/corso-backup-details-sharepoint',
'cli/corso-backup-delete-sharepoint',
'cli/corso-restore-sharepoint']
}
]
},
{
type: 'category',
label: 'Support',
items: [
'support/bugs-and-features', 'support/known-issues', 'support/faq'
],
},
{
type: 'category',
label: 'Developer guide',
items: [
'developers/build', 'developers/testing', 'developers/linters'
],
},
],
};
module.exports = sidebars;