larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enable trailing slashes for docs/website (#1603)

Browse Source 
## Description

This should fix a bunch of the errors seen by Google when indexing the website.

## Type of change

- [x] 🐛 Bugfix
- [x] 🗺️ Documentation
This commit is contained in:
Niraj Tolia 2022-11-23 15:29:20 -08:00 committed by GitHub
parent 3c32136100
commit 5c420892b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/blog/2022-11-16-corso-announcement-free-backup-for-microsoft-365.md
View File

@ -76,7 +76,7 @@ costs, as well.
## Interested in Trying Corso? ## Interested in Trying Corso?
Corso, currently in alpha, provides a CLI-based tool for backups of your M365 data. Corso, currently in alpha, provides a CLI-based tool for backups of your M365 data.
[Follow the quickstart guide](../docs/quickstart) to start protecting your business-critical M365 data in [Follow the quickstart guide](../../docs/quickstart) to start protecting your business-critical M365 data in
just a few minutes. Because Corso is currently in alpha, it should NOT be used in production. just a few minutes. Because Corso is currently in alpha, it should NOT be used in production.
Corso supports Microsoft 365 Exchange and OneDrive, with SharePoint and Teams support in active development. Coverage Corso supports Microsoft 365 Exchange and OneDrive, with SharePoint and Teams support in active development. Coverage

2
docs/docs/developers/testing.md
View File

@ -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>

4
docs/docs/intro.md
View File

@ -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.

20
docs/docs/quickstart.md
View File

@ -21,13 +21,13 @@ pull the image.
## Connect to Microsoft 365 ## Connect to Microsoft 365
Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time operation. Follow the instructions Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time operation. Follow the instructions
[here](setup/m365_access) to obtain the necessary credentials and then make them available to Corso. [here](../setup/m365_access) to obtain the necessary credentials and then make them available to Corso.
<Tabs groupId="os"> <Tabs groupId="os">
<TabItem value="win" label="Powershell"> <TabItem value="win" label="Powershell">
```powershell ```powershell
$Env:AZURE_CLIENT_ID = "<Application (client) ID for configured app>" $Env:AZURE_CLIENT_ID = "<Application (../client) ID for configured app>"
$Env:AZURE_TENANT_ID = "<Directory (tenant) ID for configured app>" $Env:AZURE_TENANT_ID = "<Directory (tenant) ID for configured app>"
$Env:AZURE_CLIENT_SECRET = "<Client secret value>" $Env:AZURE_CLIENT_SECRET = "<Client secret value>"
``` ```
@ -36,7 +36,7 @@ Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time ope
<TabItem value="unix" label="Linux/macOS"> <TabItem value="unix" label="Linux/macOS">
```bash ```bash
export AZURE_CLIENT_ID=<Application (client) ID for configured app> export AZURE_CLIENT_ID=<Application (../client) ID for configured app>
export AZURE_TENANT_ID=<Directory (tenant) ID for configured app> export AZURE_TENANT_ID=<Directory (tenant) ID for configured app>
export AZURE_CLIENT_SECRET=<Client secret value> export AZURE_CLIENT_SECRET=<Client secret value>
``` ```
@ -45,7 +45,7 @@ Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time ope
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash ```bash
export AZURE_CLIENT_ID=<Application (client) ID for configured app> export AZURE_CLIENT_ID=<Application (../client) ID for configured app>
export AZURE_TENANT_ID=<Directory (tenant) ID for configured app> export AZURE_TENANT_ID=<Directory (tenant) ID for configured app>
export AZURE_CLIENT_SECRET=<Client secret value> export AZURE_CLIENT_SECRET=<Client secret value>
``` ```
@ -55,9 +55,9 @@ Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time ope
## Create a Corso repository ## Create a Corso repository
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">
@ -202,7 +202,7 @@ docker run --env-file $HOME/.corso/corso.env \\
``` ```
Next, select one of the available backups and list all backed up emails. See Next, select one of the available backups and list all backed up emails. See
[here](cli/corso_backup_details_exchange) for more advanced filtering options. [here](../cli/corso_backup_details_exchange) for more advanced filtering options.
<Tabs groupId="os"> <Tabs groupId="os">
<TabItem value="win" label="Powershell"> <TabItem value="win" label="Powershell">
@ -285,5 +285,5 @@ A confirmation of the recovered email will be shown and the email will appear in
The above tutorial only scratches the surface for Corso's capabilities. We encourage you to dig deeper by: The above tutorial only scratches the surface for Corso's capabilities. We encourage you to dig deeper by:
* Learning about [Corso concepts and setup](setup/concepts) * Learning about [Corso concepts and setup](../setup/concepts)
* Explore Corso backup and restore options for Exchange and Onedrive in the [Command Line Reference](cli/corso) * Explore Corso backup and restore options for Exchange and Onedrive in the [Command Line Reference](../cli/corso)

2
docs/docs/setup/concepts.md
View File

@ -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](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.

2
docs/docs/setup/configuration.md
View File

@ -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](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

4
docs/docs/setup/m365_access.md
View File

@ -7,8 +7,8 @@ description: "Connect to a Microsft 365 tenant"
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
To perform backup and restore operations, Corso requires access to your [M365 tenant](concepts#m365-concepts) To perform backup and restore operations, Corso requires access to your [M365 tenant](../concepts#m365-concepts)
by creating an [Azure AD application](concepts#m365-concepts) with appropriate permissions. by creating an [Azure AD application](../concepts#m365-concepts) with appropriate permissions.
The following steps outline a simplified procedure for creating an Azure Ad application suitable for use with Corso. The following steps outline a simplified procedure for creating an Azure Ad application suitable for use with Corso.
For more details, please refer to the For more details, please refer to the

8
docs/docs/setup/repos.md
View File

@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
import TOCInline from '@theme/TOCInline'; import TOCInline from '@theme/TOCInline';
import {Version} from '@site/src/corsoEnv'; import {Version} from '@site/src/corsoEnv';
A Corso [repository](concepts#corso-concepts) stores encrypted copies of your backup data. Repositories are A Corso [repository](../concepts#corso-concepts) stores encrypted copies of your backup data. Repositories are
supported on the following object storage systems: supported on the following object storage systems:
<TOCInline toc={toc} maxHeadingLevel={2}/><br/> <TOCInline toc={toc} maxHeadingLevel={2}/><br/>
@ -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">
@ -149,4 +149,4 @@ need to use the following flag with the initial Corso `repo init` command:
Corso also supports the use of object storage systems with no TLS certificate or with self-signed Corso also supports the use of object storage systems with no TLS certificate or with self-signed
TLS certificates with the `--disable-tls` or `--disable-tls-verification` flags. TLS certificates with the `--disable-tls` or `--disable-tls-verification` flags.
[These flags](../cli/corso_repo_init_s3) should only be used for testing. [These flags](../../cli/corso_repo_init_s3) should only be used for testing.

2
docs/docs/support/faq.md
View File

@ -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>

1
docs/docusaurus.config.js
View File

@ -13,6 +13,7 @@ const config = {
onBrokenLinks: 'throw', onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw', onBrokenMarkdownLinks: 'throw',
favicon: 'img/corso_logo.svg', favicon: 'img/corso_logo.svg',
trailingSlash: true,
// GitHub pages deployment config. // GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these. // If you aren't using GitHub pages, you don't need these.