1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Thomas Heartman bb3c722f67
Docs: Update description for create + update user (#1727)
* Docs: Update description for create + update user

This change updates the documentation for the user creation API,
fixing errors mentioned in #1717:

- it's either `username` or `email` that is required on creation.
`name` is not required.
- `name` is the only required field when updating a user.

* docs: Fix overzealous prettier formatting

* docs: updated requirements for put: name OR email
2022-06-17 13:50:39 +02:00
..
.storybook docs(docs): document the use of AliasPlugin for theme resolution 2022-04-02 16:47:38 +02:00
docs Docs: Update description for create + update user (#1727) 2022-06-17 13:50:39 +02:00
src feat: update ApiRequest to accept POST w/o payloads 2022-04-27 10:55:33 +02:00
static docs: add feature toggle reference, new how-to (#1694) 2022-06-17 12:36:19 +02:00
.gitignore
babel.config.js
docusaurus.config.js docs: switch all slack links to slack.unleash.run (#1613) 2022-05-20 08:17:36 +02:00
package.json fix(deps): update react monorepo to v18.2.0 2022-06-15 00:42:43 +00:00
README.md
sidebars.js docs: add feature toggle reference, new how-to (#1694) 2022-06-17 12:36:19 +02:00
tsconfig.json

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.