mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
75c3fcd170
## What This change updates the availability notice and the code samples in the import/export docs. Specifically, the code samples have been moved to using the ApiRequest component (and thus get examples in HTTP, cURL, and HTTPie), and the import code sample now says which version it's using (version 3). ## Why The import code sample didn't say which version of the data it used, so Unleash would assume it was version 1 if you tried to run it. However, the actual data was incompatible with the v1 data format, so you'd get an error if you tried to actually import it. While fixing this, I figured it'd also be alright to add some other minor updates to bring the docs a bit more up to recent standards. |
||
|---|---|---|
| .. | ||
| .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.