1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website
Thomas Heartman 160b9a0604
docs: small fixes (#2688)
## What

This PR contains two small doc updates/fixes:

1. Update the availability notice on SSO syncing to indicate that it has
been released.
2. Add a note to the Import API description that importing environments
will make Unleash delete API keys belonging to those environments.

## Why

1. To keep the docs up to date.
2. Because this behavior surprised (and rightly so, I'd say) a user, who
then suddenly had all their SDKs unable to connect.

Co-authored-by: Nuno Góis <github@nunogois.com>
2022-12-14 15:26:41 +01:00
..
.storybook
docs docs: small fixes (#2688) 2022-12-14 15:26:41 +01:00
src
static Docs/change request beta docs (#2608) 2022-12-06 14:02:44 +01:00
.gitignore
babel.config.js
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
sidebars.js Docs/change request beta docs (#2608) 2022-12-06 14:02:44 +01:00
tsconfig.json
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.