Tweak config settings and apply Corso docs fixes (#59)

- Disable the readability style checker for now
- Remove all errors and warnings with the fixed Vale globbing
- Rename template directory
This commit is contained in:
Niraj Tolia 2022-05-20 10:28:40 -07:00 committed by GitHub
parent 930d9bd132
commit 71f04fa8d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 24 additions and 24 deletions

View File

@ -3,7 +3,7 @@ StylesPath = styles
MinAlertLevel = suggestion
Vocab = Base
Packages = Microsoft, proselint, write-good, alex, readability
Packages = Microsoft, proselint, write-good, alex
[*.md]
BasedOnStyles = Vale, Microsoft, proselint, write-good, alex, readability
BasedOnStyles = Vale, Microsoft, proselint, write-good, alex

View File

@ -1,4 +1,4 @@
.PHONY: buildimage build dev shell
.PHONY: buildimage build dev shell check
buildimage:
docker build -t "alcion/docs:latest" .

View File

@ -0,0 +1,8 @@
{
"label": "Concepts",
"position": 2,
"link": {
"type": "generated-index",
"description": "Core Corso Concepts."
}
}

View File

@ -2,17 +2,17 @@
sidebar_position: 1
---
# Corso Introduction
# Corso introduction
Let's discover **Corso in less than 5 minutes**.
Discover **Corso in less than 5 minutes**.
## Getting Started
## Getting started
### What you'll need
- Docker
- A M365 account with the following permissions:
- ...
- _
## Running Corso
@ -22,12 +22,12 @@ Corso with automatically run with the command:
docker run ...
```
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
You can type this command into Command Prompt, PowerShell, Terminal, or any other integrated terminal of your code editor.
## Your First M365 Backup
## Your first M365 backup
To **only** backup your data, run:
To backup just your own personal data, run:
```bash
docker run
docker run ...
```

View File

@ -1,8 +0,0 @@
{
"label": "Corso - Concepts",
"position": 2,
"link": {
"type": "generated-index",
"description": "5 minutes to learn the most important Corso concepts."
}
}

View File

@ -62,10 +62,10 @@ const config = {
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Tutorial',
label: 'Docs',
},
{
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/alcionai/corso',
label: 'GitHub',
position: 'right',
},
@ -75,10 +75,10 @@ const config = {
style: 'dark',
links: [
{
title: 'Docs',
title: 'Resources',
items: [
{
label: 'Tutorial',
label: 'Docs',
to: '/docs/intro',
},
],

View File

@ -14,7 +14,7 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
docsSidebar: [{type: 'autogenerated', dirName: '.'}],
// But you can create a sidebar manually
/*