Skip to content

Commit

Permalink
chore: Rm beta (#278)
Browse files Browse the repository at this point in the history
* feat(cloud): add environment configuration guide

* chore(cloud/guides): update configuring environments based on linter output

* chore: rm beta re cloud, couple fixups

Signed-off-by: Mark Phelps <[email protected]>

* chore: fmt

Signed-off-by: Mark Phelps <[email protected]>

---------

Signed-off-by: Mark Phelps <[email protected]>
Co-authored-by: George MacRorie <[email protected]>
  • Loading branch information
markphelps and GeorgeMac authored Oct 1, 2024
1 parent 9ac6c28 commit a34f7b6
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 28 deletions.
7 changes: 2 additions & 5 deletions cloud/benefits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,8 @@ mode: "wide"
---

<Info>
Flipt Cloud is currently in beta. Some functionality may be subject to
change.

Ready to try Flipt Cloud? [Sign up here](https://flipt.cloud) for a 14-day free trial.

Ready to try Flipt Cloud? [Sign up here](https://flipt.cloud) for a 14-day
free trial.
</Info>

At Flipt, we aim to provide our users with the best possible feature flagging experience. That's why we're excited to introduce Flipt Cloud, a new offering that combines the best of both worlds: the simplicity and flexibility of a cloud service with the scalability and reliability of self-hosted Flipt.
Expand Down
7 changes: 2 additions & 5 deletions cloud/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ description: This document describes the basic concepts of Flipt Cloud.
---

<Info>
Flipt Cloud is currently in beta. Some functionality may be subject to
change.

Ready to try Flipt Cloud? [Sign up here](https://flipt.cloud) for a 14-day free trial.

Ready to try Flipt Cloud? [Sign up here](https://flipt.cloud) for a 14-day
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.
Expand Down
22 changes: 13 additions & 9 deletions cloud/guides/configuring-environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ description: Learn how to configure different aspects of your Flipt environments
## Commit Messages, Pull-Request Titles and Bodies

Flipt Cloud dynamically generates commit messages and pull-requests based on parameters of the changes being made.
It passes these parameters through Go templates to produce the resulting messages.
While cloud is configured some sensible defaults, these can be overridden on a per Flipt environment basis.
It passes these parameters through [Go templates](https://pkg.go.dev/text/template) to produce the resulting messages.
While cloud is configured with some sensible defaults, these can be overridden on a per Flipt environment basis.

To override these templates you must provide a `flipt.yaml` file at the root of your environment tree.

Expand All @@ -18,10 +18,14 @@ To override these templates you must provide a `flipt.yaml` file at the root of
```

<Info>
An environment is a combination of a Git `repository`, a `branch`
name and `directory` path. These are selected when you create your environment
in Flipt Cloud. The `flipt.yaml` must exist in this directory and branch in
order to configure the relevant environment.

An environment is a combination of a Git `repository`, a `branch` name and
`directory` path. These are selected when you create your environment in Flipt
Cloud.

The `flipt.yaml` file must exist in this directory and branch in order
to configure the relevant environment.

</Info>

When this file isn't provided, a default one is implicitly generated. The default is effectively the following:
Expand Down Expand Up @@ -77,7 +81,7 @@ Simply printing out a change in the template (for example,`{{ (index .Changes 0)
<verb> <type> [<namespace>/]<key>
```

<Accordion title="Example: semantic commit messages">
<Accordion title="Example: Semantic Commit Messages">
The following gives an example of how to change the above template to produce semantic commits:

```yaml
Expand Down Expand Up @@ -123,7 +127,7 @@ The following is a pseudo-schema for the context passed to these templates:
```

<AccordionGroup>
<Accordion title="Example: Title in semantic commit message style">
<Accordion title="Example: Title in Semantic Commit Message Style">
The following gives an example of how to change the above template to produce semantic commits:

```yaml
Expand All @@ -133,7 +137,7 @@ templates:
```

</Accordion>
<Accordion title="Example: Body with organization">
<Accordion title="Example: Body With Organization">
The following gives an example of how to change the above template to produce semantic commits:

```yaml
Expand Down
7 changes: 2 additions & 5 deletions cloud/guides/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ description: Learn how to get started with Flipt Cloud
---

<Info>
Flipt Cloud is currently in beta. Some functionality may be subject to
change.

Ready to try Flipt Cloud? [Sign up here](https://flipt.cloud) for a 14-day free trial.

Ready to try Flipt Cloud? [Sign up here](https://flipt.cloud) for a 14-day
free trial.
</Info>

## Prerequisites
Expand Down
4 changes: 0 additions & 4 deletions cloud/guides/production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ description: Learn how to scale your feature flagging operations with Flipt Clou
---

<Info>
Flipt Cloud is currently in beta. Some functionality may be subject to
change.

Ready to try Flipt Cloud? [Sign up here](https://flipt.cloud) for a 14-day free trial.

</Info>

## Prerequisites
Expand Down

0 comments on commit a34f7b6

Please sign in to comment.