1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Tymoteusz Czech 2cd5028125
Docs: update API access for new token type (#1958)
* refactor how-to guide for creating a token

* fix token links

* update SDK reference

* beginning of direct api guide

* refactored frontend api guide

* lint staged breaking notes

* update docs - cors for frontend

* update token guide images

* update after review

* Apply suggestions from code review

`website/docs/user_guide/token.mdx`

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* Apply suggestions from code review

`website/docs/topics/frontend-api.md`

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* Apply suggestions from code review

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* Apply suggestions from code review

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* pr review

* docs: Add info about front-end tokens + formatting

* docs: add info about token anatomy

* docs: link to correct  place in doc

* docs: replace "direct access API" -> "front-end API"

* docs: rename file frontend-api -> front-end-api

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-09-15 09:02:10 +02:00
..
.storybook
docs Docs: update API access for new token type (#1958) 2022-09-15 09:02:10 +02:00
src docs: prep to add OpenAPI spec to Unleash docs (#1907) 2022-08-12 11:37:57 +02:00
static Docs: update API access for new token type (#1958) 2022-09-15 09:02:10 +02:00
.gitignore
babel.config.js
docusaurus.config.js docs: update images using latest UI screenshots (#1992) 2022-09-14 07:59:18 +00:00
package.json fix(deps): update dependency docusaurus-theme-openapi-docs to v1.1.9 (#2032) 2022-08-31 22:55:20 +00:00
README.md
sidebars.js Docs: update API access for new token type (#1958) 2022-09-15 09:02:10 +02:00
tsconfig.json
yarn.lock fix(deps): update dependency docusaurus-theme-openapi-docs to v1.1.9 (#2032) 2022-08-31 22:55:20 +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.