1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website
Christopher Kolstad 4007ebfffb
docs: Update proxy hosting to point to Frontend API (#4191)
### What
We had a customer wonder why `/api/proxy/development` wasn't configured
for them. After some digging it was found that they'd followed our
documentation and assumed that the proxy was configured for them.
However, since we no longer host proxies, this was not the case. This PR
updates the documentation to point out that "Unleash hosts everything"
now means that our clients should use Frontend API keys and the
`/api/frontend` endpoint to get what they used to get from embedded
proxies.

## Missing
We should make a new illustration in the same vein as the other
illustrations on this page to demonstrate what the Frontend API really
is. This PR removes the reference to the picture of the topology of
having Unleash hosting proxies.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-07-11 10:55:54 +02:00
..
.storybook
docs docs: Update proxy hosting to point to Frontend API (#4191) 2023-07-11 10:55:54 +02:00
remote-content
src feat: expose kapi as part of docs (#3996) 2023-06-23 13:55:59 +02:00
static docs: project overview (#4176) 2023-07-07 11:50:54 +02:00
.gitignore
babel.config.js
clean-generated-docs.js
docusaurus.config.js chore: add reo to docs 2023-07-07 12:52:46 +02:00
global.js fix: do not include rio server-side 2023-07-07 14:08:50 +02:00
package.json chore(deps): update dependency got to v13 (#3952) 2023-07-05 13:25:45 +02:00
README.md
sidebars.js docs: switch order of api doc sidebar items; put legacy docs under legacy header (#4135) 2023-07-04 14:19:34 +02:00
tsconfig.json
yarn.lock chore(deps): update dependency got to v13 (#3952) 2023-07-05 13:25:45 +02: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.