diff --git a/docs/docs/developers/testing.md b/docs/docs/developers/testing.md index f0e8ce7a3..2e7ee8bd3 100644 --- a/docs/docs/developers/testing.md +++ b/docs/docs/developers/testing.md @@ -30,7 +30,7 @@ - Set M365 Credentials environment variables - > You can find more information on how to get these values in our [M365 docs](/setup/m365_access). + > You can find more information on how to get these values in our [M365 docs](../setup/m365_access). ```bash export AZURE_CLIENT_ID= diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 911c06cb9..823394737 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -12,6 +12,6 @@ beyond M365, will expand based on the interest and needs of the community. ## Getting started -You can follow the [Quick Start](/quickstart) guide for an end-to-end Corso walk through. Alternatively, follow -the instructions in the [Corso Setup](/setup/concepts) section to dive into the details on how to configure and +You can follow the [Quick Start](quickstart) guide for an end-to-end Corso walk through. Alternatively, follow +the instructions in the [Corso Setup](setup/concepts) section to dive into the details on how to configure and run Corso. diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index 88aa29dd6..53cefa1af 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -57,7 +57,7 @@ Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time ope To create a secure backup location for Corso, you will first need to [download Corso](setup/download). Use the container or native executable to initialize the Corso repository using an -[encryption passphrase](/setup/configuration#environment-variables) and a pre-created S3 bucket (Corso doesn't create +[encryption passphrase](setup/configuration#environment-variables) and a pre-created S3 bucket (Corso doesn't create the bucket if it doesn't exist). The steps below use `corso-test` as the bucket name but, if you are using AWS, you will need a different unique name for the bucket. @@ -118,7 +118,7 @@ docker run --env-file $HOME/.corso/corso.env \\ ## Create your first backup Corso can do much more, but you can start by creating a backup of your Exchange mailbox. If it has been a while since -you initialized the Corso repository, you might need to [connect to it again](/setup/repos#connect-to-a-repository). +you initialized the Corso repository, you might need to [connect to it again](setup/repos#connect-to-a-repository). diff --git a/docs/docs/setup/concepts.md b/docs/docs/setup/concepts.md index ff4bb2dd2..d8ff7f7e5 100644 --- a/docs/docs/setup/concepts.md +++ b/docs/docs/setup/concepts.md @@ -21,7 +21,7 @@ application to connect to your *M365 tenant* and transfer data during backup and ## Corso concepts {#corso-concepts} * **Repository** refers to the storage location where Corso securely and efficiently stores encrypted *backups* of your -*M365 Services* data. See [Repositories](/setup/repos) for more information. +*M365 Services* data. See [Repositories](repos) for more information. * **Backup** is a copy of your *M365 Services* data to be used for restores in case of deletion, loss, or corruption of the original data. Corso performs backups incrementally, and each backup only captures data that has changed between backup iterations. diff --git a/docs/docs/setup/configuration.md b/docs/docs/setup/configuration.md index 1ec5d299c..15506e9ec 100644 --- a/docs/docs/setup/configuration.md +++ b/docs/docs/setup/configuration.md @@ -14,7 +14,7 @@ Two things are needed to configure Corso: Three distinct pieces of configuration are required by Corso: -* S3 object storage configuration to store backups. See [AWS Credentials Setup](/setup/repos#s3-creds-setup) for +* S3 object storage configuration to store backups. See [AWS Credentials Setup](repos#s3-creds-setup) for alternate ways to pass AWS credentials. * `AWS_ACCESS_KEY_ID`: Access key for an IAM user or role for accessing an S3 bucket * `AWS_SECRET_ACCESS_KEY`: Secret key associated with the access key diff --git a/docs/docs/setup/repos.md b/docs/docs/setup/repos.md index 6cfd728b4..7a6a4ca62 100644 --- a/docs/docs/setup/repos.md +++ b/docs/docs/setup/repos.md @@ -67,7 +67,7 @@ The two most commonly-used options are: ### Initialize repository Before first use, you need to initialize a Corso repository with `corso repo init s3`. See the command details -[here](/cli/corso_repo_init_s3). +[here](../cli/corso_repo_init_s3). @@ -104,7 +104,7 @@ docker run --env-file $HOME/.corso/corso.env \\ ### Connect to a repository If a repository already exists, you can connect to it with `corso repo connect s3`. See the command details -[here](/cli/corso_repo_connect_s3). +[here](../cli/corso_repo_connect_s3). diff --git a/docs/docs/support/faq.md b/docs/docs/support/faq.md index 1538b6a25..b19fc9f97 100644 --- a/docs/docs/support/faq.md +++ b/docs/docs/support/faq.md @@ -16,7 +16,7 @@ metadata for basic information about installed versions and usage in a privacy-p generic description of most-commonly used backup operations and statistics on the duration and size of backups. No user data is stored or transmitted during this process. -Telemetry reporting can be turned off by using the `--no-stats` flag. See the [Command Line Reference](cli/corso) +Telemetry reporting can be turned off by using the `--no-stats` flag. See the [Command Line Reference](../cli/corso) section for more information. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 525fa3769..8b1e1b32c 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -43,7 +43,6 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { - routeBasePath: '/', sidebarPath: require.resolve('./sidebars.js'), remarkPlugins: [require('mdx-mermaid')], editUrl: @@ -104,7 +103,7 @@ const config = { items: [ { label: 'Docs', - to: '/intro', + to: '/docs/intro', }, ], }, diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 8e34c1deb..4226bade3 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -16,8 +16,8 @@ function HomepageHeader() {
- Corso Quickstart - 5min ⏱️ + to="/docs/quickstart"> + Corso Quickstart