1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Pål-Magnus Slåtto 3edca3efe8
[docs]: Update Prometheus docs with security info (#2246)
## About the changes

Prometheus metrics should not be exposed to the public. Added a note about this to inform people that internal endpoints should be dropped on external access.

## Discussion points

https://unleash-community.slack.com/archives/CGP2MCHPF/p1666688295670459

## Commits

* [docs]: Update Prometheus docs with security info

* Apply suggestions from code review

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

* Add info about Prometheus security

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-10-28 09:58:26 +00:00
..
.storybook
docs [docs]: Update Prometheus docs with security info (#2246) 2022-10-28 09:58:26 +00:00
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.