1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Thomas Heartman 222f34f43d
docs: add large segments explainer (#3441)
This PR adds an explainer document about using large/complex
constraints, inspired by the Unleash and Redis repo.

The intent is to create a comprehensive and understandable explanation
as to why we don't recommend you do this, and also to offer alternative
solutions for the same problem.

---------

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2023-04-14 12:59:07 +00:00
..
.storybook
docs docs: add large segments explainer (#3441) 2023-04-14 12:59:07 +00:00
remote-content docs: remove "under construction" message for edge (#3351) 2023-03-21 08:36:38 +01:00
src docs: remove unleash client from the docs (#3378) 2023-03-23 13:26:42 +01:00
static docs: Project api token (#3405) 2023-03-29 11:39:37 +03:00
.gitignore
babel.config.js
clean-generated-docs.js
docusaurus.config.js docs: add google tag manager (#3428) 2023-03-31 07:27:25 +02:00
package.json chore(deps): update dependency @babel/core to v7.21.4 (#3479) 2023-04-07 19:08:20 +00:00
README.md
sidebars.js docs: add large segments explainer (#3441) 2023-04-14 12:59:07 +00:00
tsconfig.json
yarn.lock chore(deps): update dependency @babel/core to v7.21.4 (#3479) 2023-04-07 19:08:20 +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.