mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
ea00ea9d56
## About the changes Adds troubleshooting guides for some common problems under the how-to area (following the [diataxis framework](https://diataxis.fr/)). This is part of Unleash 2023 offsite challenge --------- Co-authored-by: Drew Gorton <drew.gorton@getunleash.io> Co-authored-by: Diego Susa <diego@getunleash.io> Co-authored-by: Michael Vittiglio <michael.vittiglio@getunleash.io> Co-authored-by: Thomas Heartman <thomas@getunleash.ai> |
||
|---|---|---|
| .. | ||
| .storybook | ||
| docs | ||
| remote-content | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| clean-generated-docs.js | ||
| docusaurus.config.js | ||
| global.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tsconfig.json | ||
| yarn.lock | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
yarn install
Generate Open API docs
yarn generate
Generate the Open API docs that live at Reference documentation > APIs > OpenAPI
Local Development
yarn start
Start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.