Skip to content

Commit

Permalink
chore: remove snap, rename deployment (#941)
Browse files Browse the repository at this point in the history
Signed-off-by: Todd Baert <[email protected]>
  • Loading branch information
toddbaert authored Sep 27, 2023
1 parent 68ebe96 commit fc0610d
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ erDiagram

### In-Process evaluation

In-process deployments embed the flagd evaluation engine directly into the client application through the use of an [in-process provider](./deployment.md#in-process).
In-process deployments embed the flagd evaluation engine directly into the client application through the use of an [in-process provider](./installation.md#in-process).
The in-process provider is connected via the sync protocol to an implementing [gRPC service](./concepts/syncs.md#grpc-sync) that provides the flag definitions.
This pattern requires an in-process implementation of the flagd evaluation engine, but has the benefit of no I/O overhead, since no inter-process communication is required.

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ flagd is sub-project of OpenFeature and aims to be fully [OpenFeature-compliant]
> How do I run flagd?
You can run flagd as a standalone application, accessible over HTTP or gRPC, or you can embed it into your application.
Please see [architecture](./architecture.md) and [deployment](./deployment.md) for more information.
Please see [architecture](./architecture.md) and [installation](./installation.md) for more information.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Thanks to it's minimalism, it's _extremely flexible_; you can leverage flagd as

flagd is designed to fit well into a variety of infrastructures, and can run on various architectures.
It run as a separate process or directly in your application (see [architecture](./architecture.md)).
It's distributed as a binary, container image, and various libraries (see [deployment](./deployment.md)).
It's distributed as a binary, container image, and various libraries (see [installation](./installation.md)).
If you're already leveraging containers in your infrastructure, you can extend the docker image with your required configuration.
You can also run flagd as a service on a VM or a "bare-metal" host.
If you'd prefer not to run an additional process at all, you can run the flagd evaluation engine directly in your application.
Expand Down
8 changes: 1 addition & 7 deletions docs/deployment.md → docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Deployment
# Installation

## Docker

Expand Down Expand Up @@ -40,12 +40,6 @@ A systemd wrapper is available [here](https:/open-feature/flagd/blob
brew install flagd
```

### Snap

```shell
sudo snap install flagd
```

### Go binary

```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ flagd was built from the ground up to be [Openfeature-compliant](../concepts/fea
To use it in your application, you must use the [OpenFeature SDK](https://openfeature.dev/docs/reference/technologies/) for your language, along with the associated OpenFeature _provider_.
For more information about Openfeature providers, see the [OpenFeature documentation](https://openfeature.dev/docs/reference/concepts/provider).

Providers for flagd come in two flavors: those that are built to communicate with a flagd instance (over HTTP or gRPC) and those that embed flagd's evaluation engine directly (note that some providers are capable of operating in either mode). For more information on how to deploy and use flagd, see [architecture](../architecture.md) and [deployment](../deployment.md).
Providers for flagd come in two flavors: those that are built to communicate with a flagd instance (over HTTP or gRPC) and those that embed flagd's evaluation engine directly (note that some providers are capable of operating in either mode). For more information on how to deploy and use flagd, see [architecture](../architecture.md) and [installation](../installation.md).

For a catalog of available flagd providers, check out the [OpenFeature ecosystem](https://openfeature.dev/ecosystem?instant_search%5Bquery%5D=flagd&instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=Provider) page.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ markdown_extensions:
nav:
- 'Introduction': 'index.md'
- 'Quick start': 'quick-start.md'
- 'Installation': 'installation.md'
- 'Concepts':
- 'Feature Flagging': 'concepts/feature-flagging.md'
- 'Syncs': 'concepts/syncs.md'
- 'Architecture': 'architecture.md'
- 'Deployment': 'deployment.md'
- 'Reference':
- 'CLI':
- 'Commands': 'reference/flagd-cli/flagd.md'
Expand Down

0 comments on commit fc0610d

Please sign in to comment.