d877240d4f
## Description - Remove bucket creationn from the quickstart - Remove repo connect from the quickstart - Add examples to the repo page - Reoder setup pages given pre-requisites to the examples on the repo page - Cleanups, edits, and clarifications on the repo page ## Type of change <!--- Please check the type of change your PR introduces: ---> - [x] 🌻 Feature - [x] 🐛 Bugfix - [x] 🗺️ Documentation ## Issue(s) <!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. --> * Closes #1262
Corso documentation
Corso documentation uses Docusaurus 2, a modern static website generator. Mermaid provides support for native diagrams in Markdown.
Requirements
Developing documentation for Corso requires the following tools on your machine:
make- Docker
Installation
make buildimage
Live documentation development
make dev
This command starts a local development server within the Docker container and will expose docs at http://localhost:3000.
Generating Corso CLI docs
make genclidocs
Corso's CLI documents are auto generated. This command explicitly triggers generating these docs. This step will happen automatically for the other commands where this is relevant.
Building static documentation
make build
This command generates static content into the build directory for integration with any static contents hosting service.
Style and linting
# Lint all docs
make check
# Lint specific files and/or folders
make check VALE_TARGET="README.md docs/concepts"
This command will lint all Markdown files and check them for style issues using the Docker container
Documentation platform development
make shell
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).