mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
fa74f81aa5
* docs: add all /events endpoints and query params * docs: events page skeleton structure * docs: correct description of event payloads * docs: add table with event properties. * docs: remove duplicate table. * docs: sort property table * docs: more work on adding events: feature events * docs: add examples for most feature events Still missing are: events that require imports, and feature-project-change * docs: scaffold out all events descriptions * docs: normalize casing * docs: add brief descriptions to strategy and context events * docs: Add remaining non-import event descriptions and examples * docs: add code sample annotations for all example events. * docs: remove all references to myself * docs: change "toggle" -> "feature", adjust headings The headings aren't semantic for this doc yet. We'll need to create a new document for this. * docs: update event type description table * docs: change header level of event type section * docs: add details around feature-project-change event * docs: add import type events * docs: use a better `createdBy` name * docs: "sort" events so that they're in a consistent order. * docs: remove reference to ID in addon-config-created event * fix: drop-environments data.name all-projects -> all-environments This is probably a bug. Should be double checked. * docs: clarify that `data.name` is always `all-x` on drop events * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> Co-authored-by: sighphyre <liquidwicked64@gmail.com> |
||
|---|---|---|
| .. | ||
| .storybook | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| 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.