From d4881d1cf02fa6730d0a9033f285b9e69ef7bd67 Mon Sep 17 00:00:00 2001 From: Abin Simon Date: Fri, 9 Feb 2024 06:45:26 +0530 Subject: [PATCH] Fix up website linting CI job (#17) * Fix up internal links * Don't show warnings or suggestions We never really looked at it, we only took the errors into account. It was just making finding the errors harder. --------- Co-authored-by: ashmrtn <3891298+ashmrtn@users.noreply.github.com> --- website/.vale.ini | 2 +- website/docs/quickstart.md | 6 +-- website/docs/setup/repos.md | 10 ++--- website/docs/support/faq.md | 2 +- website/sidebars.js | 76 ++++++++++++++++++------------------- 5 files changed, 48 insertions(+), 48 deletions(-) diff --git a/website/.vale.ini b/website/.vale.ini index 6ccb3ad7e..209c13917 100644 --- a/website/.vale.ini +++ b/website/.vale.ini @@ -1,6 +1,6 @@ StylesPath = styles -MinAlertLevel = suggestion +MinAlertLevel = error ; we were never looking into warning or suggestions Vocab = Base Packages = Microsoft, proselint, write-good, alex diff --git a/website/docs/quickstart.md b/website/docs/quickstart.md index 3020d6f6a..8db72aac1 100644 --- a/website/docs/quickstart.md +++ b/website/docs/quickstart.md @@ -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-s3-repository). @@ -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 -[here](../cli/corso-backup-details-exchange) for more advanced filtering options. +[here](../cli/canario-backup-details-exchange) for more advanced filtering options. @@ -339,5 +339,5 @@ See [here](../setup/restore-options) for more restoration options. 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) -* Explore Corso backup and restore options for M365 Applications in the [Command Line Reference](../cli/corso) +* Explore Corso backup and restore options for M365 Applications in the [Command Line Reference](../cli/canario) * Leverage Corso's [Advanced Restoration Options](../setup/restore-options) diff --git a/website/docs/setup/repos.md b/website/docs/setup/repos.md index d76834d3e..cfa3aa4bd 100644 --- a/website/docs/setup/repos.md +++ b/website/docs/setup/repos.md @@ -76,7 +76,7 @@ The two most commonly-used options are: ### Initialize a S3 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/canario-repo-init-s3). @@ -113,7 +113,7 @@ docker run --env-file $HOME/.corso/corso.env \\ ### Connect to a S3 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/canario-repo-connect-s3). @@ -158,7 +158,7 @@ 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 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/canario-repo-init-s3) should only be used for testing. ## Filesystem Storage @@ -170,7 +170,7 @@ production. ### Initialize a filesystem repository Before first use, you need to initialize a Corso repository with `corso repo init filesystem`. See the command details -[here](../../cli/corso-repo-init-filesystem). Corso will create the directory structure if necessary, including any +[here](../../cli/canario-repo-init-filesystem). Corso will create the directory structure if necessary, including any missing parent directories. Filesystem repositories don't support the `--prefix` option but instead use the `--path` option. Repository directories @@ -213,7 +213,7 @@ docker run --env-file $HOME/.corso/corso.env \\ ### Connect to a filesystem repository If a repository already exists, you can connect to it with `corso repo connect filesystem`. See the command details -[here](../../cli/corso-repo-connect-filesystem). +[here](../../cli/canario-repo-connect-filesystem). diff --git a/website/docs/support/faq.md b/website/docs/support/faq.md index 4f5233a3a..7773d2c69 100644 --- a/website/docs/support/faq.md +++ b/website/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/canario) section for more information. diff --git a/website/sidebars.js b/website/sidebars.js index 17063ef1d..e3e1c1bfb 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -35,8 +35,8 @@ const sidebars = { type: 'category', label: 'Command line reference', link: { - slug: 'cli/corso', - description: 'Explore the commonly-used Corso CLI commands', + slug: 'cli/canario', + description: 'Explore the commonly-used Canario CLI commands', type: 'generated-index', }, items: [ @@ -45,76 +45,76 @@ const sidebars = { label: 'Setup and maintenance', link: { slug: 'cli/setup', - description: 'Documentation for Corso setup and maintenance commands', + description: 'Documentation for Canario setup and maintenance commands', }, items: [ - 'cli/corso-repo-init-s3', - 'cli/corso-repo-connect-s3', - 'cli/corso-repo-init-filesystem', - 'cli/corso-repo-connect-filesystem', - 'cli/corso-repo-maintenance', - 'cli/corso-repo-update-passphrase', - 'cli/corso-env'] + 'cli/canario-repo-init-s3', + 'cli/canario-repo-connect-s3', + 'cli/canario-repo-init-filesystem', + 'cli/canario-repo-connect-filesystem', + 'cli/canario-repo-maintenance', + 'cli/canario-repo-update-passphrase', + 'cli/canario-env'] }, { type: 'category', label: 'Exchange', link: { slug: 'cli/exchange', - description: 'Documentation for commonly-used Corso Exchange CLI commands', + description: 'Documentation for commonly-used Canario 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', - 'cli/corso-export-exchange'] + 'cli/canario-backup-create-exchange', + 'cli/canario-backup-list-exchange', + 'cli/canario-backup-details-exchange', + 'cli/canario-backup-delete-exchange', + 'cli/canario-restore-exchange', + 'cli/canario-export-exchange'] }, { type: 'category', label: 'Groups & Teams', link: { slug: 'cli/groups', - description: 'Documentation for commonly-used Corso Groups & Teams CLI commands', + description: 'Documentation for commonly-used Canario Groups & Teams CLI commands', }, items: [ - 'cli/corso-backup-create-groups', - 'cli/corso-backup-list-groups', - 'cli/corso-backup-details-groups', - 'cli/corso-backup-delete-groups', - 'cli/corso-restore-groups', - 'cli/corso-export-groups'] + 'cli/canario-backup-create-groups', + 'cli/canario-backup-list-groups', + 'cli/canario-backup-details-groups', + 'cli/canario-backup-delete-groups', + 'cli/canario-restore-groups', + 'cli/canario-export-groups'] }, { type: 'category', label: 'OneDrive', link: { slug: 'cli/onedrive', - description: 'Documentation for commonly-used Corso OneDrive CLI commands', + description: 'Documentation for commonly-used Canario 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', - 'cli/corso-export-onedrive'] + 'cli/canario-backup-create-onedrive', + 'cli/canario-backup-list-onedrive', + 'cli/canario-backup-details-onedrive', + 'cli/canario-backup-delete-onedrive', + 'cli/canario-restore-onedrive', + 'cli/canario-export-onedrive'] }, { type: 'category', label: 'SharePoint', link: { slug: 'cli/sharepoint', - description: 'Documentation for commonly-used Corso SharePoint CLI commands', + description: 'Documentation for commonly-used Canario 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', - 'cli/corso-export-sharepoint'] + 'cli/canario-backup-create-sharepoint', + 'cli/canario-backup-list-sharepoint', + 'cli/canario-backup-details-sharepoint', + 'cli/canario-backup-delete-sharepoint', + 'cli/canario-restore-sharepoint', + 'cli/canario-export-sharepoint'] } ] },