mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

History

Gastón Fournier ea00ea9d56 docs: troubleshooting guides (#4592 ) ## 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>		2023-09-01 15:39:23 +02:00
..
.storybook
docs	docs: troubleshooting guides (#4592 )	2023-09-01 15:39:23 +02:00
remote-content
src	feat: expose kapi as part of docs (#3996 )	2023-06-23 13:55:59 +02:00
static	feat: change request reject docs and step update (#4493 )	2023-08-16 09:46:05 +02:00
.gitignore
babel.config.js
clean-generated-docs.js
docusaurus.config.js	chore: add reo to docs	2023-07-07 12:52:46 +02:00
global.js	fix: do not include rio server-side	2023-07-07 14:08:50 +02:00
package.json	chore(deps): update react-router monorepo to v6.15.0 (#4532 )	2023-08-17 18:52:04 +00:00
README.md	Integrations - frontend adjustments (#4527 )	2023-08-22 14:40:38 +02:00
sidebars.js	docs: troubleshooting guides (#4592 )	2023-09-01 15:39:23 +02:00
tsconfig.json
yarn.lock	chore(deps): update react-router monorepo to v6.15.0 (#4532 )	2023-08-17 18:52:04 +00:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

yarn generate

Generate the Open API docs that live at Reference documentation > APIs > OpenAPI

yarn start

Start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

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.