mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
c2a3872386
## What This change updates some places in the docs where we use the terms "login" and "logout" incorrectly. A "login" is a noun, typically referring to the set of credentials you need to _log in_ to a service. The verb form, the act of signing in, is written in two words: to "log in". A similar logic applies to "logout" and "log out", although I don't find the term "logout" in my dictionary. However, I think it makes sense to talk about "logout requests" (and I see references to logout in other services and documentation), so I'm happy to use that as a noun. Regardless, the act of logging out is to "log out". |
||
|---|---|---|
| .. | ||
| .storybook | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| clean-generated-docs.js | ||
| docusaurus.config.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tsconfig.json | ||
| yarn.lock | ||
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.