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

Corso documentation platform changes (#62)

Browse Source 
* Add tools requirements for Corso docs

* Add README.md to Vale checks and ensure a clean run

* Swap from Discord to GH discussions
This commit is contained in:
Niraj Tolia 2022-05-20 11:00:44 -07:00 committed by GitHub
parent cab6a515d9
commit 85a06d2409
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@ -10,7 +10,7 @@ dev:
check: check:
docker run --rm \ docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs vale docs -v ${PWD}:/usr/src/docs alcion/docs vale docs README.md
docker run --rm \ docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ -v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/

26
docs/README.md
View File

@ -1,6 +1,13 @@
# Corso Documentation # Corso documentation
Corso documentation is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. Corso documentation uses [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Requirements
Developing documentation for Corso requires the following tools on your machine:
- `make`
- Docker
## Installation ## Installation
@ -8,7 +15,7 @@ Corso documentation is built using [Docusaurus 2](https://docusaurus.io/), a mod
make buildimage make buildimage
``` ```
## Live Docs ## Live documentation development
```bash ```bash
make dev make dev
@ -16,15 +23,15 @@ make dev
This command starts a local development server within the Docker container and will expose docs at [http://localhost:3000](http://localhost:3000). This command starts a local development server within the Docker container and will expose docs at [http://localhost:3000](http://localhost:3000).
## Build Docs ## Building static documentation
```bash ```bash
make build make build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory for integration with any static contents hosting service.
## Check Docs ## Style and linting
```bash ```bash
make check make check
@ -32,11 +39,12 @@ make check
This command will lint all Markdown files and check them for style issues. This command will lint all Markdown files and check them for style issues.
## Documentation Platform Development ## Documentation platform development
```bash ```bash
make shell make shell
``` ```
This command is when you want to interactively (and temporarily!) change the contents or Use this command to interactively (and temporarily!) change the contents or
configuration of the live documentation container image. configuration of the live documentation container image (for example, when
experimenting with new plugins).

4
docs/docusaurus.config.js
View File

@ -87,8 +87,8 @@ const config = {
title: 'Community', title: 'Community',
items: [ items: [
{ {
label: 'Discord', label: 'Discussions',
href: 'https://discordapp.com/invite/docusaurus', href: 'https://github.com/alcionai/corso/discussions',
}, },
{ {
label: 'Twitter', label: 'Twitter',