Corso documentation platform changes (#62)
* 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:
parent
cab6a515d9
commit
85a06d2409
@ -10,7 +10,7 @@ dev:
|
||||
|
||||
check:
|
||||
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 \
|
||||
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -8,7 +15,7 @@ Corso documentation is built using [Docusaurus 2](https://docusaurus.io/), a mod
|
||||
make buildimage
|
||||
```
|
||||
|
||||
## Live Docs
|
||||
## Live documentation development
|
||||
|
||||
```bash
|
||||
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).
|
||||
|
||||
## Build Docs
|
||||
## Building static documentation
|
||||
|
||||
```bash
|
||||
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
|
||||
make check
|
||||
@ -32,11 +39,12 @@ make check
|
||||
|
||||
This command will lint all Markdown files and check them for style issues.
|
||||
|
||||
## Documentation Platform Development
|
||||
## Documentation platform development
|
||||
|
||||
```bash
|
||||
make shell
|
||||
```
|
||||
|
||||
This command is when you want to interactively (and temporarily!) change the contents or
|
||||
configuration of the live documentation container image.
|
||||
Use this command to interactively (and temporarily!) change the contents or
|
||||
configuration of the live documentation container image (for example, when
|
||||
experimenting with new plugins).
|
||||
|
||||
@ -87,8 +87,8 @@ const config = {
|
||||
title: 'Community',
|
||||
items: [
|
||||
{
|
||||
label: 'Discord',
|
||||
href: 'https://discordapp.com/invite/docusaurus',
|
||||
label: 'Discussions',
|
||||
href: 'https://github.com/alcionai/corso/discussions',
|
||||
},
|
||||
{
|
||||
label: 'Twitter',
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user