1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Simon Hornby e437b61753
docs: update group docs to reflect that users is not optional (#2667)
The reference documentation for groups is incorrect, groups always
require a list of users

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-12-16 10:45:15 +01:00
..
.storybook docs(docs): document the use of AliasPlugin for theme resolution 2022-04-02 16:47:38 +02:00
docs docs: update group docs to reflect that users is not optional (#2667) 2022-12-16 10:45:15 +01:00
src docs: add "The Anatomy of Unleash" (#2138) 2022-10-19 13:14:49 +02:00
static Docs/change request beta docs (#2608) 2022-12-06 14:02:44 +01:00
.gitignore Docs/public signup (#2070) 2022-10-10 16:12:11 +03:00
babel.config.js fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00
clean-generated-docs.js chore: update docusaurus/openapi integration to stable version (#2414) 2022-11-14 08:52:46 +01:00
docusaurus.config.js Chore: correctly format docusaurus.config.js 2022-12-13 08:27:00 +01:00
package.json fix(deps): update dependency docusaurus-theme-openapi-docs to v1.4.7 (#2652) 2022-12-09 20:17:43 +00:00
README.md fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00
sidebars.js Docs/change request beta docs (#2608) 2022-12-06 14:02:44 +01:00
tsconfig.json chore: convert feedback component to typescript 2022-03-02 10:50:46 +01:00
yarn.lock fix(deps): update dependency docusaurus-theme-openapi-docs to v1.4.7 (#2652) 2022-12-09 20:17:43 +00:00

Website

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

Installation

yarn install

Local Development

yarn start

This command starts 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.