From 71f04fa8d0cbdc22c52ed7534c0310f7de9bbaea Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Fri, 20 May 2022 10:28:40 -0700 Subject: [PATCH] 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 --- docs/.vale.ini | 4 ++-- docs/Makefile | 2 +- docs/docs/concepts/_category_.json | 8 ++++++++ .../corso-repository-and-configuration.md | 0 docs/docs/intro.md | 16 ++++++++-------- docs/docs/tutorial-basics/_category_.json | 8 -------- docs/docusaurus.config.js | 8 ++++---- docs/sidebars.js | 2 +- 8 files changed, 24 insertions(+), 24 deletions(-) create mode 100644 docs/docs/concepts/_category_.json rename docs/docs/{tutorial-basics => concepts}/corso-repository-and-configuration.md (100%) delete mode 100644 docs/docs/tutorial-basics/_category_.json diff --git a/docs/.vale.ini b/docs/.vale.ini index 90bea5b32..f7caf98b0 100644 --- a/docs/.vale.ini +++ b/docs/.vale.ini @@ -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 diff --git a/docs/Makefile b/docs/Makefile index c299d1e4a..66171db09 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,4 +1,4 @@ -.PHONY: buildimage build dev shell +.PHONY: buildimage build dev shell check buildimage: docker build -t "alcion/docs:latest" . diff --git a/docs/docs/concepts/_category_.json b/docs/docs/concepts/_category_.json new file mode 100644 index 000000000..af6ca99a5 --- /dev/null +++ b/docs/docs/concepts/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Concepts", + "position": 2, + "link": { + "type": "generated-index", + "description": "Core Corso Concepts." + } +} diff --git a/docs/docs/tutorial-basics/corso-repository-and-configuration.md b/docs/docs/concepts/corso-repository-and-configuration.md similarity index 100% rename from docs/docs/tutorial-basics/corso-repository-and-configuration.md rename to docs/docs/concepts/corso-repository-and-configuration.md diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 204a43d26..e808d3275 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -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 ... ``` diff --git a/docs/docs/tutorial-basics/_category_.json b/docs/docs/tutorial-basics/_category_.json deleted file mode 100644 index 940cb37c7..000000000 --- a/docs/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Corso - Concepts", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Corso concepts." - } -} diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 1cdb1f38e..13cb4dc28 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -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', }, ], diff --git a/docs/sidebars.js b/docs/sidebars.js index fd342f2cd..eeade5309 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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 /*