1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-11 00:08:30 +01:00
unleash.unleash/website
Thomas Heartman 983d3a9513
docs: clarify node sdk instructions wrt envs and tokens (#2799)
## What

This change does two things:

It **removes the `environment` option** from the initialization
examples. This option is deprecated and only causes confusion. There's
no good reason to have it lying around in the examples.

It also **updates the explanation of the code samples**, telling you
that you need to generate an API key and linking you to the reference
doc and how to guide.

Relates to: #2782.
2023-01-03 11:26:17 +01:00
..
.storybook
docs docs: clarify node sdk instructions wrt envs and tokens (#2799) 2023-01-03 11:26:17 +01:00
src docs: add "The Anatomy of Unleash" (#2138) 2022-10-19 13:14:49 +02:00
static
.gitignore
babel.config.js
clean-generated-docs.js
docusaurus.config.js chore: remove constraints announcements from readme and docs (#2678) 2023-01-03 10:11:04 +01:00
package.json fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.0 (#2763) 2022-12-29 00:04:18 +00:00
README.md
sidebars.js
tsconfig.json
yarn.lock fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.0 (#2763) 2022-12-29 00:04:18 +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.