Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add link to feature flags best practices #287

Merged
merged 1 commit into from
Oct 3, 2023
Merged

docs: Add link to feature flags best practices #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![crates.io](https://img.shields.io/crates/v/unleash-edge?label=latest)](https://crates.io/crates/unleash-edge)
[![Documentation](https://docs.rs/unleash-edge/badge.svg?version=latest)](https://docs.rs/unleash-edge/latest)
![MIT licensed](https://img.shields.io/crates/l/unleash-edge.svg)
[![Dependency Status](https://deps.rs/crate/unleash-edge/12.0.0/status.svg)](https://deps.rs/crate/unleash-edge/12.0.0)
[![Dependency Status](https://deps.rs/crate/unleash-edge/13.0.0/status.svg)](https://deps.rs/crate/unleash-edge/13.0.0)
[![CI](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml/badge.svg)](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml)
[![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-edge/badge.svg?branch=main)](https://coveralls.io/github/Unleash/unleash-edge?branch=main)
![downloads](https://img.shields.io/crates/d/unleash-edge.svg)
Expand All @@ -17,7 +17,10 @@ Unleash Edge offers two important features:
- **Performance**: Unleash Edge caches in memory and can run close to your end-users. A single instance can handle tens to hundreds of thousands of requests per second.
- **Resilience**: Unleash Edge is designed to survive restarts and operate properly even if you lose connection to your Unleash server.

Unleash Edge is built to help you scale Unleash, if you're looking for the easiest way to connect your client SDKs you can check out our [Frontend API](https://docs.getunleash.io/reference/front-end-api).
Unleash Edge is built to help you scale Unleash.
* If you're looking for the easiest way to connect your client SDKs you can check out our [Frontend API](https://docs.getunleash.io/reference/front-end-api).
* If you're looking to learn how to scale your own feature flag system why not check out our recommendations for building and scaling [feature flags](https://docs.getunleash.io/topics/feature-flags/feature-flag-best-practices)


## Migrating to Edge from the Proxy

Expand Down
9 changes: 6 additions & 3 deletions server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![crates.io](https://img.shields.io/crates/v/unleash-edge?label=latest)](https://crates.io/crates/unleash-edge)
[![Documentation](https://docs.rs/unleash-edge/badge.svg?version=latest)](https://docs.rs/unleash-edge/latest)
![MIT licensed](https://img.shields.io/crates/l/unleash-edge.svg)
[![Dependency Status](https://deps.rs/crate/unleash-edge/12.0.0/status.svg)](https://deps.rs/crate/unleash-edge/12.0.0)
[![Dependency Status](https://deps.rs/crate/unleash-edge/13.0.0/status.svg)](https://deps.rs/crate/unleash-edge/13.0.0)
[![CI](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml/badge.svg)](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml)
[![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-edge/badge.svg?branch=main)](https://coveralls.io/github/Unleash/unleash-edge?branch=main)
![downloads](https://img.shields.io/crates/d/unleash-edge.svg)
Expand All @@ -17,7 +17,10 @@ Unleash Edge offers two important features:
- **Performance**: Unleash Edge caches in memory and can run close to your end-users. A single instance can handle tens to hundreds of thousands of requests per second.
- **Resilience**: Unleash Edge is designed to survive restarts and operate properly even if you lose connection to your Unleash server.

Unleash Edge is built to help you scale Unleash, if you're looking for the easiest way to connect your client SDKs you can check out our [Frontend API](https://docs.getunleash.io/reference/front-end-api).
Unleash Edge is built to help you scale Unleash.
* If you're looking for the easiest way to connect your client SDKs you can check out our [Frontend API](https://docs.getunleash.io/reference/front-end-api).
* If you're looking to learn how to scale your own feature flag system why not check out our recommendations for building and scaling [feature flags](https://docs.getunleash.io/topics/feature-flags/feature-flag-best-practices)


## Migrating to Edge from the Proxy

Expand Down Expand Up @@ -283,7 +286,7 @@ Options:

##### Environments in offline mode
Currently, Edge does not support multiple environments in offline mode. All tokens added at startup will receive the same list of features passed in as the bootstrap argument.
However, tokens in <project>:<environment>.<secret> format will still filter by project.
However, tokens in `<project>:<environment>.<secret>` format will still filter by project.

## [Metrics](https://docs.getunleash.io/reference/api/unleash/metrics)

Expand Down