Correctly route docs pages (#1541)
## Description This has led to bugs earlier. This also removes absolute paths to prevent further breakages. ## Type of change <!--- Please check the type of change your PR introduces: ---> - [x] 🐛 Bugfix - [x] 🗺️ Documentation
This commit is contained in:
parent
cca5759d7f
commit
f2c7bde155
@ -30,7 +30,7 @@
|
|||||||
|
|
||||||
- Set M365 Credentials environment variables
|
- 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
|
```bash
|
||||||
export AZURE_CLIENT_ID=<id>
|
export AZURE_CLIENT_ID=<id>
|
||||||
|
|||||||
@ -12,6 +12,6 @@ beyond M365, will expand based on the interest and needs of the community.
|
|||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
You can follow the [Quick Start](/quickstart) guide for an end-to-end Corso walk through. Alternatively, follow
|
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
|
the instructions in the [Corso Setup](setup/concepts) section to dive into the details on how to configure and
|
||||||
run Corso.
|
run Corso.
|
||||||
|
|||||||
@ -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).
|
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
|
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
|
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.
|
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
|
## 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
|
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).
|
||||||
|
|
||||||
<Tabs groupId="os">
|
<Tabs groupId="os">
|
||||||
<TabItem value="win" label="Powershell">
|
<TabItem value="win" label="Powershell">
|
||||||
|
|||||||
@ -21,7 +21,7 @@ application to connect to your *M365 tenant* and transfer data during backup and
|
|||||||
## Corso concepts {#corso-concepts}
|
## Corso concepts {#corso-concepts}
|
||||||
|
|
||||||
* **Repository** refers to the storage location where Corso securely and efficiently stores encrypted *backups* of your
|
* **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
|
* **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.
|
original data. Corso performs backups incrementally, and each backup only captures data that has changed between backup iterations.
|
||||||
|
|||||||
@ -14,7 +14,7 @@ Two things are needed to configure Corso:
|
|||||||
|
|
||||||
Three distinct pieces of configuration are required by 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.
|
alternate ways to pass AWS credentials.
|
||||||
* `AWS_ACCESS_KEY_ID`: Access key for an IAM user or role for accessing an S3 bucket
|
* `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
|
* `AWS_SECRET_ACCESS_KEY`: Secret key associated with the access key
|
||||||
|
|||||||
@ -67,7 +67,7 @@ The two most commonly-used options are:
|
|||||||
### Initialize repository
|
### Initialize repository
|
||||||
|
|
||||||
Before first use, you need to initialize a Corso repository with `corso repo init s3`. See the command details
|
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).
|
||||||
|
|
||||||
<Tabs groupId="os">
|
<Tabs groupId="os">
|
||||||
<TabItem value="win" label="Powershell">
|
<TabItem value="win" label="Powershell">
|
||||||
@ -104,7 +104,7 @@ docker run --env-file $HOME/.corso/corso.env \\
|
|||||||
### Connect to a repository
|
### Connect to a repository
|
||||||
|
|
||||||
If a repository already exists, you can connect to it with `corso repo connect s3`. See the command details
|
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).
|
||||||
|
|
||||||
<Tabs groupId="os">
|
<Tabs groupId="os">
|
||||||
<TabItem value="win" label="Powershell">
|
<TabItem value="win" label="Powershell">
|
||||||
|
|||||||
@ -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
|
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.
|
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.
|
section for more information.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|||||||
@ -43,7 +43,6 @@ const config = {
|
|||||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||||
({
|
({
|
||||||
docs: {
|
docs: {
|
||||||
routeBasePath: '/',
|
|
||||||
sidebarPath: require.resolve('./sidebars.js'),
|
sidebarPath: require.resolve('./sidebars.js'),
|
||||||
remarkPlugins: [require('mdx-mermaid')],
|
remarkPlugins: [require('mdx-mermaid')],
|
||||||
editUrl:
|
editUrl:
|
||||||
@ -104,7 +103,7 @@ const config = {
|
|||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'Docs',
|
label: 'Docs',
|
||||||
to: '/intro',
|
to: '/docs/intro',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
@ -16,8 +16,8 @@ function HomepageHeader() {
|
|||||||
<div className={styles.buttons}>
|
<div className={styles.buttons}>
|
||||||
<Link
|
<Link
|
||||||
className="button button--secondary button--lg"
|
className="button button--secondary button--lg"
|
||||||
to="quickstart">
|
to="/docs/quickstart">
|
||||||
Corso Quickstart - 5min ⏱️
|
Corso Quickstart
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user