Skip to content

Commit

Permalink
chore: fix grammar issues
Browse files Browse the repository at this point in the history 
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
  • Loading branch information
@markphelps
markphelps committed Dec 18, 2024
1 parent d5636df commit 62b3e4f
Show file tree
Hide file tree
Showing 22 changed files with 52 additions and 52 deletions.
2 changes: 1 addition & 1 deletion authorization/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ You can find more information on how to write Rego policies in the [OPA document
policies before deploying them.
</Tip>

It's up to you to define the policies that make sense for your organization. During policy evaluation, Flipt will pass the incoming request context to the built in Open Policy Agent, which will then evaluate the policy against that context.
It's up to you to define the policies that make sense for your organization. During policy evaluation, Flipt will pass the incoming request context to the built-in Open Policy Agent, which will then evaluate the policy against that context.

The context provided to OPA includes the following fields:

Expand Down
2 changes: 1 addition & 1 deletion cli/commands/validate.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ flipt validate [flags]

This command validates Flipt's declarative feature configuration files.

It looks for features flag definitions in the same way as Flipt's declarative backends. Checkout the documentation on [locating flag state](/configuration/storage#locating-flag-state) to learn more about this process.
It looks for feature flag definitions in the same way as Flipt's declarative backends. Checkout the documentation on [locating flag state](/configuration/storage#locating-flag-state) to learn more about this process.

### Extra Schema

Expand Down
2 changes: 1 addition & 1 deletion cloud/architecture.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn about the architecture of Flipt Cloud and how it scales to me
mode: "wide"
---

This section describes the high-level architecture of Flipt Cloud and how you can also run you own Flipt instances for evaluation purposes while still leveraging the service.
This section describes the high-level architecture of Flipt Cloud and how you can also run your own Flipt instances for evaluation purposes while still leveraging the service.

Check warning on line 7 in cloud/architecture.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "cloud/architecture.mdx", "range": {"start": {"line": 7, "column": 1}}}, "severity": "WARNING"}

Check warning on line 7 in cloud/architecture.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "cloud/architecture.mdx", "range": {"start": {"line": 7, "column": 85}}}, "severity": "WARNING"}

## Overview

Expand Down
4 changes: 2 additions & 2 deletions cloud/concepts.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ description: This document describes the basic concepts of Flipt Cloud.
free trial.
</Info>

Flipt Cloud is a fully solution where we host and operate Flipt for you. You no longer need to deploy or manage Flipt instances yourself. We provide a secure, scalable, and feature-rich environment with enterprise-grade authentication and authorization built-in.
Flipt Cloud is a fully managed solution where we host and operate Flipt for you. You no longer need to deploy or manage Flipt instances yourself. We provide a secure, scalable, and feature-rich environment with enterprise-grade authentication and authorization built-in.

Check warning on line 11 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "cloud/concepts.mdx", "range": {"start": {"line": 11, "column": 47}}}, "severity": "WARNING"}

Check warning on line 11 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "cloud/concepts.mdx", "range": {"start": {"line": 11, "column": 147}}}, "severity": "WARNING"}

While Flipt Cloud is a completely service, it works hand in hand with Flipt Open Source. You can still deploy Flipt Open Source in your own infrastructure to scale as needed, while still using Flipt Cloud for feature flag management.
Flipt Cloud works hand in hand with Flipt Open Source. You can still deploy Flipt Open Source in your own infrastructure to scale as needed, while still using Flipt Cloud for feature flag management.

Here are some of the basic concepts in Flipt Cloud:

Expand Down
2 changes: 1 addition & 1 deletion cloud/features/authentication.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Flipt Cloud supports Single Sign-On (SSO) with popular identity providers like O

SSO also enhances security by reducing the number of passwords your team members need to remember and ensuring that access is granted only to authorized users.

You can even setup custom SAML and OIDC providers, so you can use your existing identity management system with Flipt Cloud, even if it's not one of our supported identity providers.
You can even set up custom SAML and OIDC providers, so you can use your existing identity management system with Flipt Cloud, even if it's not one of our supported identity providers.

Check warning on line 25 in cloud/features/authentication.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "cloud/features/authentication.mdx", "range": {"start": {"line": 25, "column": 1}}}, "severity": "WARNING"}

Check warning on line 25 in cloud/features/authentication.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "cloud/features/authentication.mdx", "range": {"start": {"line": 25, "column": 53}}}, "severity": "WARNING"}

Check warning on line 25 in cloud/features/authentication.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "cloud/features/authentication.mdx", "range": {"start": {"line": 25, "column": 151}}}, "severity": "WARNING"}

## API Access

Expand Down
6 changes: 3 additions & 3 deletions cloud/guides/production.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Copy the API key to your clipboard and save it in a secure location. You will no

## Configure a Client-Side SDK

Currently, Flipt Cloud only support client-side SDKs for direct evaluation via the Flipt Cloud API.
Currently, Flipt Cloud only supports client-side SDKs for direct evaluation via the Flipt Cloud API.

<Note>
For more information on the architecture of Flipt Cloud, see the
Expand All @@ -71,7 +71,7 @@ Currently, Flipt Cloud only support client-side SDKs for direct evaluation via t

<Steps>
<Step title="Install the SDK">
Chose the SDK that matches your application's language and install it. All client-side SDKs are documented [here](/integration/client).
Choose the SDK that matches your application's language and install it. All client-side SDKs are documented [here](/integration/client).
</Step>

<Step title="Configure the SDK">
Expand Down Expand Up @@ -131,7 +131,7 @@ Here's how you can configure your Flipt instances to use the Git repository data
</Step>
<Step title="Install the SDK">
Chose the SDK that matches your application's language and install it. All server-side SDKs are documented [here](/integration/server).
Choose the SDK that matches your application's language and install it. All server-side SDKs are documented [here](/integration/server).
<Note>
You can also use any of our [OpenFeature SDKs](/integration/openfeature) or [OpenFeature Remote Evaluation Protocol implementations](/integration/openfeature#remote-evaluation-protocol) to evaluate feature flags within your infrastructure.
Expand Down
4 changes: 2 additions & 2 deletions cloud/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: Our Cloud offering is the simplest, scalable solution for getting s
width: "100%",
height: "100%",
}}
title="Sneak Peak: Flipt Cloud"
title="Sneak Peek: Flipt Cloud"
></iframe>
</div>
<script src="https://player.vimeo.com/api/player.js"></script>
Expand All @@ -34,7 +34,7 @@ description: Our Cloud offering is the simplest, scalable solution for getting s

- **Cost-Effective and Predictable Pricing**: Enjoy a simple, predictable pricing model based on the features you need, not on the number of flags or evaluations. This allows for better budget planning and eliminates unexpected costs as your usage grows.

- **Ready from the Start**: Jump right in with Flipt’s intuitive management user interface, available from day one. This immediate readiness ensures a smooth, hassle-free start to your feature flag management journey.
- **Ready from the Start**: Jump right in with Flipt's intuitive management user interface, available from day one. This immediate readiness ensures a smooth, hassle-free start to your feature flag management journey.

- **Effortless User Management**: Simplify user authentication and login processes without extra configuration or hosting expenses. Our platform is designed for ease, making user management a breeze right out of the box.

Expand Down
2 changes: 1 addition & 1 deletion configuration/analytics.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,4 @@ analytics:
prometheus:
headers:
"Authorization": "Bearer <token>"
```
```
14 changes: 7 additions & 7 deletions configuration/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ The server will check in a few different locations for server configuration (in
schema](https://raw.githubusercontent.com/flipt-io/flipt/main/config/flipt.schema.json)
and a [Cue
schema](https://raw.githubusercontent.com/flipt-io/flipt/main/config/flipt.schema.cue)
that you can use to validate your configuration file and it's properties.
that you can use to validate your configuration file and its properties.
</Note>

You can edit any of these properties to your liking, and on restart Flipt will
You can edit any of these properties to your liking, and on restart, Flipt will
pick up the new changes.

### Environment Substitution
Expand Down Expand Up @@ -467,11 +467,11 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001"

#### Analytics: Prometheus

| Property | Description | Default | Since |
| ------------------------------------ | ----------------------------------- | ------- | ------- |
| analytics.storage.prometheus.enabled | Enable Prometheus support | false | v1.52.0 |
| analytics.storage.prometheus.url | URL to connect to prometheus server | | v1.52.0 |
| analytics.storage.prometheus.headers | Additional headers to send with Prometheus requests (map[string]string) | | v1.52.1 |
| Property | Description | Default | Since |
| ------------------------------------ | ----------------------------------------------------------------------- | ------- | ------- |
| analytics.storage.prometheus.enabled | Enable Prometheus support | false | v1.52.0 |
| analytics.storage.prometheus.url | URL to connect to prometheus server | | v1.52.0 |
| analytics.storage.prometheus.headers | Additional headers to send with Prometheus requests (map[string]string) | | v1.52.1 |

### Metrics

Expand Down
8 changes: 4 additions & 4 deletions guides/migration/launchdarkly/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ description: Migrate from LaunchDarkly to Flipt in 4 simple steps
mode: "wide"
---

If you’re already a LaunchDarkly user, migrating from LaunchDarkly to Flipt is a simple, 4-step process.
If you're already a LaunchDarkly user, migrating from LaunchDarkly to Flipt is a simple, 4-step process.

We suggest you follow the steps one after the other, in the order they’re listed. This will allow you to rollback changes easily, in case of a migration error.
We suggest you follow the steps one after the other, in the order they're listed. This will allow you to rollback changes easily, in case of a migration error.

Check warning on line 9 in guides/migration/launchdarkly/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "guides/migration/launchdarkly/overview.mdx", "range": {"start": {"line": 9, "column": 1}}}, "severity": "WARNING"}

Check warning on line 9 in guides/migration/launchdarkly/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "guides/migration/launchdarkly/overview.mdx", "range": {"start": {"line": 9, "column": 88}}}, "severity": "WARNING"}

Check warning on line 9 in guides/migration/launchdarkly/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.

Raw Output:
{"message": "[Microsoft.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.", "location": {"path": "guides/migration/launchdarkly/overview.mdx", "range": {"start": {"line": 9, "column": 123}}}, "severity": "WARNING"}

1. [**Migrating from LaunchDarkly SDK to OpenFeature SDK**](/guides/migration/launchdarkly/openfeature)

First, we’ll identify all flag instances in your codebase, and migrate them
First, we'll identify all flag instances in your codebase, and migrate them
from the traditional LaunchDarkly SDK to the OpenFeature SDK. This will
enable us to make as little modifications as possible to your codebase, and
allow you to replace feature flagging vendors with ease.
Expand All @@ -22,7 +22,7 @@ the LaunchDarkly OpenFeature provider to the Flipt OpenFeature provider.

3. [**Installing Flipt**](/guides/migration/launchdarkly/flipt#installing-flipt)

In order to use Flipt, you would need to install it in your infrastructure.
In order to use Flipt, you will need to install it in your infrastructure.

If you want us to handle the running and maintenance of Flipt, you can
leverage our [Cloud](/cloud/overview) offering.
Expand Down
4 changes: 2 additions & 2 deletions guides/operation/authentication/login-with-github.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ OAuth 2.0 is an authentication standard whose goal is to allow 3rd party applica

![OAuth 2.0 Flow Diagram](/images/guides/login-with-github/oauth-flow-diagram.png)

In comparison to OIDC, OAuth 2.0 doesn't have an identity standard, so retrieving identity can vary drastically from provider to provider. Therefore, it's up to the user to consult the OAuth 2.0 provider's documentation to understand if and how identity information can be retrieved.
Unlike OIDC, OAuth 2.0 does not have a standardized identity layer, which means the process of retrieving identity information varies between providers. Users should consult their OAuth 2.0 provider's documentation to understand the specific methods for retrieving identity information.

## Creating a GitHub OAuth 2.0 Application

Expand Down Expand Up @@ -112,6 +112,6 @@ After completion of the flow you should be taken to the normal Flipt homepage an

![Flipt Dashboard](/images/guides/login-with-github/flipt-dashboard.png)

This guide shows the basics of getting Flipt running with GitHub OAuth 2.0 authentication in a development.
This guide shows the basics of getting Flipt running with GitHub OAuth 2.0 authentication in a development environment.

Now that you know the basics, you can tailor the configuration pieces to fit your exact use cases. For instance, you would not use `localhost:8080` in a production setting, but rather a custom domain. If you have a custom domain, you can modify the `Authorization Callback URL` value on the GitHub OAuth application page, the `redirect_address`, and `domain` configuration values for the Flipt configuration.
12 changes: 6 additions & 6 deletions guides/operation/authentication/login-with-google.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ In this step, we run Flipt and mount our local `config.yml` file into the runnin
This will start Flipt as a process in the foreground of your current terminal session.
You can stop Flipt by entering `ctrl+C`.

This particular command forwards your localhost port `8080` into the container's localhost post `8080`.
This particular command forwards your localhost port `8080` into the container's localhost port `8080`.
The `8080` port is the default for Flipt's HTTP service and can be changed via the `server` configuration parameter.

```sh
Expand Down Expand Up @@ -144,7 +144,7 @@ Once selected you will be presented with more input options.

![Google cloud create oauth client ID form](/images/guides/login-with-google/create-oauth-client-id-form.png)

3. Configure the clients name and redirect URL.
3. Configure the client's name and redirect URL.

As shown in the screenshot, we'll want to enter the following values for the inputs:

Expand Down Expand Up @@ -221,7 +221,7 @@ It's used by Flipt as the domain for storing authentication cookies.

Note that we've enabled the `oidc` method, and it has a section called `providers`.
Each key beneath the `providers` section is unique and can be whatever you want.
However, the name is important as it effects the `redirect_url` generated for the particular provider.
However, the name is important as it affects the `redirect_url` generated for the particular provider.
If you change this provider name from `google` to something else, then you will need to update your [OAuth client details](#3-configure-the-oauth-client) in Google Cloud.
For example, changing it from `google` to `gcp` would result in the redirect URI changing like so:

Expand All @@ -238,7 +238,7 @@ The `scopes` section is optional, and allows Flipt the opportunity to obtain add

You can now stop and start your Flipt instance using the Docker command we described in Section 1.

Once Flipt has restarted you can to navigate your browser to the [UI](http://localhost:8080) and attempt a login with Google.
Once Flipt has restarted you can navigate your browser to the [UI](http://localhost:8080) and attempt a login with Google.
When you click `Login with Google` you should be navigated away to your Google consent screen.
Once you grant consent, you should return to Flipt and be logged into Flipt.

Expand Down Expand Up @@ -302,14 +302,14 @@ authentication:
Using browser session based authentication puts applications at risk of cross-site request forgery attacks.
Flipt supports automatic CSRF prevention via signed token strings, using a shared signing key.

Checkout our [Configuration: Session](/configuration/authentication#session) documentation for details on how to configure this.
Check out our [Configuration: Session](/configuration/authentication#session) documentation for details on how to configure this.

2. Move credentials to environment variables

Sometimes for security purposes you don't want to be inserting your sensitive credentials (such as provider `client_secret` or your CSRF `key`) into a configuration file.
Flipt supports defining configuration in its YAML file and as environment variables.

Checkout our [Configuration: Environment Variables](/configuration/overview#environment-variables) section for details on how to provide configuration as environment variables.
Check out our [Configuration: Environment Variables](/configuration/overview#environment-variables) section for details on how to provide configuration as environment variables.

As a quick example, both the Google provider `client_secret` and the CSRF signing `key` can be presented to Flipt like so:

Expand Down
6 changes: 3 additions & 3 deletions guides/operation/authentication/login-with-keycloak.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ http://localhost:8080/realms/flipt/.well-known/openid-configuration

## Running Flipt

Now that we've an OIDC client configured in our Keycloak instance, we can begin configuring Flipt to leverage it.
Now that we have an OIDC client configured in our Keycloak instance, we can begin configuring Flipt to leverage it.

### 1. Define a Flipt `config.yml`

Expand Down Expand Up @@ -153,7 +153,7 @@ authentication:
The session domain is required for session-compatible authentication methods. It's used by Flipt as the domain for storing authentication cookies.
Note that we've enabled the `oidc` method, and it has a section called `providers`. Each key beneath the `providers` section is unique and can be whatever you want. However, the name is important as it effects the `redirect_url` generated for the particular provider.
Note that we've enabled the `oidc` method, and it has a section called `providers`. Each key beneath the `providers` section is unique and can be whatever you want. However, the name is important as it affects the `redirect_url` generated for the particular provider.

Each provider section has a consistent structure. You're required to provide the `issuer_url`, `client_id`, `client_secret` and `redirect_address`.

Expand All @@ -176,7 +176,7 @@ When you click `Login with Keycloak` you should be navigated away to your Keyclo

![Keycloak login screen](/images/guides/login-with-keycloak/keycloak-login.png)

Once you successfully authenticate with the username/password you created earlier, you should return to Flipt and be logged into.
Once you successfully authenticate with the username/password you created earlier, you should return to Flipt and be logged in.

![Flipt dashboard](/images/guides/login-with-keycloak/flipt-dashboard.png)

Expand Down
2 changes: 1 addition & 1 deletion guides/operation/authorization/rbac-with-keycloak.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,4 @@ By defining a Rego policy that enforces the roles and permissions for your organ

For more information on Flipt's authorization system and how to configure and use it, see the [Authorization Overview](/authorization/overview).

In the future we plan to provide more examples and best practices for using Flipt's authorization system with different authentication providers and use cases. If you have any feedback or suggestions for how we can improve this guide, please let us know!
In the future, we plan to provide more examples and best practices for using Flipt's authorization system with different authentication providers and use cases. If you have any feedback or suggestions for how we can improve this guide, please let us know!
2 changes: 1 addition & 1 deletion guides/operation/deployment/deploy-to-kubernetes.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,4 @@ You should be able to take the knowledge you've gained in this guide and deploy
Please refer to the [Flipt Helm chart repository](https://github.com/flipt-io/helm-charts) for more information on how to configure Flipt using the Helm chart.

Additionally, you should checkout our documentation on our native [Kubernetes authentication method](/authentication/methods#kubernetes).
This method can be leverage to automatically authenticate clients, without the need to manually manage credentials, for applications deployed into the same Kubernetes cluster as Flipt.
This method can be leveraged to automatically authenticate clients, without the need to manually manage credentials, for applications deployed into the same Kubernetes cluster as Flipt.
Loading

0 comments on commit 62b3e4f

Please sign in to comment.