1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Thomas Heartman 4de3ff3d2f
docs: feature flag naming patterns (#4632)
This PR adds a reference doc and a how-to doc for feature flag naming
patterns.

Extra thanks to @sebastian-bury for the draft from the offsite 👏🏼
2023-09-11 15:28:10 +02:00
..
.storybook
docs docs: feature flag naming patterns (#4632) 2023-09-11 15:28:10 +02:00
remote-content docs: remove "under construction" message for edge (#3351) 2023-03-21 08:36:38 +01:00
src
static docs: feature flag naming patterns (#4632) 2023-09-11 15:28:10 +02: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: 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: feature flag naming patterns (#4632) 2023-09-11 15:28:10 +02:00
tsconfig.json chore: convert feedback component to typescript 2022-03-02 10:50:46 +01:00
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

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.