Skip to content

Commit 2f74bfd

Browse files
docs: Change buttons + remove duplicate redirection (#2887)
1 parent 93672b0 commit 2f74bfd

File tree

5 files changed

+36
-74
lines changed

5 files changed

+36
-74
lines changed

Diff for: README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ GO Feature Flag is a lightweight and open-source solution that provides a simple
5353

5454
The solution has been built to facilitate the usage of feature flags in your code with the easiest setup possible.
5555

56-
Originally, **GO Feature Flag** was designed as a solution exclusively for the `GO` language. With the new standardization of feature flags by the [Openfeature](https://openfeature.dev/) project, the solution is now available for multiple languages _([list of supported languages](https://gofeatureflag.org/docs/openfeature_sdk/sdk))_ through a simple API server called the relay proxy, which can be hosted.
56+
Originally, **GO Feature Flag** was designed as a solution exclusively for the `GO` language. With the new standardization of feature flags by the [Openfeature](https://openfeature.dev/) project, the solution is now available for multiple languages _([list of supported languages](https://gofeatureflag.org/docs/sdk))_ through a simple API server called the relay proxy, which can be hosted.
5757

5858
> [!TIP]
5959
> If you are not familiar with feature flags, I've written an [article](https://medium.com/better-programming/feature-flags-and-how-to-iterate-quickly-7e3371b9986) which explains why feature flags can fasten your iteration cycle.
@@ -64,10 +64,10 @@ Originally, **GO Feature Flag** was designed as a solution exclusively for the `
6464
- Configuring your flags in various [format](https://gofeatureflag.org/docs/configure_flag/flag_format) (`JSON`, `TOML` and `YAML`).
6565
- Adding complex [rules](https://gofeatureflag.org/docs/configure_flag/flag_format#rule-format) to target your users.
6666
- Use a complex rollout strategy for your flags :
67-
- [Run A/B testing experimentation](https://gofeatureflag.org/docs/configure_flag/rollout/experimentation).
68-
- [Progressively rollout a feature](https://gofeatureflag.org/docs/configure_flag/rollout/progressive).
69-
- [Schedule your flag updates](https://gofeatureflag.org/docs/configure_flag/rollout/scheduled).
70-
- Exporting your flags usage data to various destinations such as _(`S3`, `Google cloud storage`, `file`, see the [_full list_](https://gofeatureflag.org/docs/configure_flag/export_flags_usage))_.
67+
- [Run A/B testing experimentation](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/experimentation).
68+
- [Progressively rollout a feature](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/progressive).
69+
- [Schedule your flag updates](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/scheduled).
70+
- Exporting your flags usage data to various destinations such as _(`S3`, `Google cloud storage`, `file`, `kubernetes`, see the [_full list_](https://gofeatureflag.org/docs/docs/integrations/store-flags-configuration#available-retrievers))_.
7171
- Getting notified when a flag has been changed _(`webhook` and `slack`)_.
7272
- Use **GO Feature Flag** in several languages with **Open Feature SDKs**.
7373
- Support your full stack, from the backend to the frontend including your mobile apps.
@@ -141,11 +141,11 @@ docker run \
141141
142142
```
143143

144-
_If you don't want to use docker to install the **relay proxy** you can follow other ways to install it in the [documentation](https://gofeatureflag.org/docs/relay_proxy/install_relay_proxy)._
144+
_If you don't want to use docker to install the **relay proxy** you can follow other ways to install it in the [documentation](https://gofeatureflag.org/docs/docs/relay-proxy/install_relay_proxy)._
145145

146146
### Use Open Feature SDK
147147

148-
_In this example, we are using the **nodejs SDK**, but you can check other languages [here](https://gofeatureflag.org/docs/openfeature_sdk/sdk)._
148+
_In this example, we are using the **nodejs SDK**, but you can check other languages [here](https://gofeatureflag.org/docs/sdk)._
149149

150150

151151
#### Install dependencies
@@ -241,7 +241,7 @@ PollingInterval, the default value is 60 seconds).*
241241

242242
> ℹ info
243243
This is a basic configuration to test locally, in production it is better to use a remote place to store your feature flag configuration file.
244-
Look at the list of available options in the [**Store your feature flag file** page](https://gofeatureflag.org/docs/go_module/store_file/).
244+
Look at the list of available options in the [**Store your feature flag file** page](https://gofeatureflag.org/docs/docs/integrations/store-flags-configuration#available-retrievers).
245245

246246
### Evaluate your flags
247247
Now you can evaluate your flags anywhere in your code.
@@ -302,7 +302,7 @@ The available retrievers are:
302302
- **AzBlobStorage**
303303
- ...
304304

305-
_[See the full list and more information.](https://gofeatureflag.org/docs/configure_flag/store_your_flags)_
305+
_[See the full list and more information.](https://gofeatureflag.org/docs/docs/integrations/store-flags-configuration#available-retrievers)_
306306

307307
## Flags file format
308308
**GO Feature Flag** core feature is to centralize all your feature flags in a single file and to avoid hosting and maintaining a backend server to manage them.
@@ -449,7 +449,7 @@ end = 2021-03-21T05:00:00.100Z
449449

450450
</details>
451451

452-
For detailed information on the fields required to create a flag, please refer to the [documentation](https://gofeatureflag.org/docs/configure_flag/flag_format).
452+
For detailed information on the fields required to create a flag, please refer to the [documentation](https://gofeatureflag.org/docs/docs/configure_flag/target-with-flags).
453453

454454
## Rule format
455455

@@ -532,10 +532,10 @@ But it does not have to, having a complex **rollout** strategy allows you to hav
532532

533533
### Complex rollout strategy available
534534

535-
- [Canary releases](https://gofeatureflag.org/docs/configure_flag/rollout/canary) - impact randomly a subset of your users.
536-
- [Progressive rollout](https://gofeatureflag.org/docs/configure_flag/rollout/progressive) - increase the percentage of your flag over time.
537-
- [Scheduled rollout](https://gofeatureflag.org/docs/configure_flag/rollout/scheduled/) - update your flag over time.
538-
- [Experimentation rollout](https://gofeatureflag.org/docs/configure_flag/rollout/experimentation) - serve your feature only for a determined time *(perfect for A/B testing)*.
535+
- [Percentages rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/percentage) - impact randomly a subset of your users.
536+
- [Progressive rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/progressive) - increase the percentage of your flag over time.
537+
- [Scheduled rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/scheduled) - update your flag over time.
538+
- [Experimentation rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/experimentation) - serve your feature only for a determined time *(perfect for A/B testing)*.
539539

540540
## Notifiers
541541
If you want to be informed when a flag has changed, you can configure a [**notifier**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#NotifierConfig).

Diff for: website/docs/sdk/server_providers/openfeature_go.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This code block shows you how you can create a client that you can use in your a
4848
import (
4949
// ...
5050
gofeatureflag "github.com/open-feature/go-sdk-contrib/providers/go-feature-flag/pkg"
51-
of "github.com/open-feature/go-sdk/pkg/openfeature"
51+
of "github.com/open-feature/go-sdk/openfeature"
5252
)
5353

5454
// ...

Diff for: website/docusaurus.config.js

-32
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,10 @@ const config = {
6363
from: '/docs/configure_flag/rollout/progressive',
6464
to: '/docs/configure_flag/rollout-strategies/progressive',
6565
},
66-
{
67-
from: '/docs/go_module/store_file/github',
68-
to: '/docs/integrations/store-flags-configuration/github',
69-
},
7066
{
7167
from: '/docs/category/configure-your-feature-flags',
7268
to: '/docs/configure_flag/create-flags',
7369
},
74-
{
75-
from: '/docs/openfeature_sdk/server_providers/openfeature_go',
76-
to: '/docs/sdk/server_providers/openfeature_go',
77-
},
7870
{
7971
from: '/docs/openfeature_sdk/server_providers/openfeature_ruby',
8072
to: '/docs/sdk/server_providers/openfeature_ruby',
@@ -83,14 +75,6 @@ const config = {
8375
from: '/docs/go_module/store_file/mongodb',
8476
to: '/docs/integrations/store-flags-configuration/mongodb',
8577
},
86-
{
87-
from: '/docs/openfeature_sdk/server_providers/openfeature_java',
88-
to: '/docs/sdk/server_providers/openfeature_java',
89-
},
90-
{
91-
from: '/docs/openfeature_sdk/server_providers/openfeature_javascript',
92-
to: '/docs/sdk/server_providers/openfeature_javascript',
93-
},
9478
{
9579
from: '/docs/relay_proxy/deploy_relay_proxy',
9680
to: '/docs/relay-proxy/deployment',
@@ -99,22 +83,10 @@ const config = {
9983
from: '/docs/go_module/store_file/github',
10084
to: '/docs/integrations/store-flags-configuration/github',
10185
},
102-
{
103-
from: '/docs/category/configure-your-feature-flags',
104-
to: '/docs/configure_flag/create-flags',
105-
},
10686
{
10787
from: '/docs/openfeature_sdk/server_providers/openfeature_go',
10888
to: '/docs/sdk/server_providers/openfeature_go',
10989
},
110-
{
111-
from: '/docs/openfeature_sdk/server_providers/openfeature_ruby',
112-
to: '/docs/sdk/server_providers/openfeature_ruby',
113-
},
114-
{
115-
from: '/docs/go_module/store_file/mongodb',
116-
to: '/docs/integrations/store-flags-configuration/mongodb',
117-
},
11890
{
11991
from: '/docs/openfeature_sdk/server_providers/openfeature_java',
12092
to: '/docs/sdk/server_providers/openfeature_java',
@@ -123,10 +95,6 @@ const config = {
12395
from: '/docs/openfeature_sdk/server_providers/openfeature_javascript',
12496
to: '/docs/sdk/server_providers/openfeature_javascript',
12597
},
126-
{
127-
from: '/docs/relay_proxy/deploy_relay_proxy',
128-
to: '/docs/relay-proxy/deployment',
129-
},
13098
{
13199
from: '/docs/go_module/store_file/custom',
132100
to: '/docs/integrations/store-flags-configuration#custom-retriever',

Diff for: website/src/components/home/HomeHeader/index.js

+20-26
Original file line numberDiff line numberDiff line change
@@ -71,36 +71,30 @@ export function HomeHeader() {
7171
/>
7272
</Link>
7373
</div>
74-
<div className={styles.availableGH}>
75-
<Link
76-
to={siteConfig.customFields.github}
77-
type="button"
78-
className={clsx('btn btn-dark btn-labeled btn-lg')}>
79-
<button className="pushy__btn pushy__btn--df pushy__btn--black">
80-
<span className="btn-label">
81-
<i className="fa-brands fa-github"></i>
82-
</span>{' '}
74+
<div className={'text-center items-center gap-30'}>
75+
<div className="relative inline-flex group">
76+
<div className="absolute transitiona-all duration-1000 opacity-70 -inset-px bg-gradient-to-r from-[#44BCFF] via-[#FF44EC] to-[#FF675E] rounded-xl blur-lg group-hover:opacity-100 group-hover:-inset-1 group-hover:duration-200 animate-tilt"></div>
77+
<Link
78+
to={siteConfig.customFields.github}
79+
title="Available on GitHub"
80+
className="hover:no-underline hover:text-gray-500 relative inline-flex items-center justify-center px-8 py-4 text-lg font-bold text-white transition-all duration-200 bg-gray-900 font-pj rounded-xl focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-900">
81+
<i className="fa-brands fa-github mr-4"></i>
8382
Available on GitHub
84-
</button>
85-
</Link>
86-
<Link
87-
to={'/docs/getting-started'}
88-
type="button"
89-
className={clsx('btn btn-dark btn-labeled btn-lg')}>
90-
<button
91-
className={clsx(
92-
'pushy__btn pushy__btn--df',
93-
styles.pushy__btnGoff
94-
)}>
95-
<span className="btn-label">
96-
<i className="fa-solid fa-circle-right"></i>
97-
</span>{' '}
83+
</Link>
84+
</div>
85+
<div className="relative inline-flex group ml-5 mt-4">
86+
<div className="border-gray-700 border-4 absolute transitiona-all duration-1000 opacity-70 -inset-px bg-gradient-to-r from-[#44BCFF] via-[#FF44EC] to-[#FF675E] rounded-xl blur-lg group-hover:opacity-100 group-hover:-inset-1 group-hover:duration-200 animate-tilt hover:no-underline"></div>
87+
<Link
88+
to={'/docs/getting-started'}
89+
title="Get Started"
90+
className="hover:no-underline hover:text-gray-700 relative inline-flex items-center justify-center px-8 py-4 text-lg font-bold text-white transition-all duration-200 bg-[#9fbeb3] font-pj rounded-xl focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-900">
91+
<i className="fa-solid fa-circle-right mr-4"></i>
9892
Get Started
99-
</button>
100-
</Link>
93+
</Link>
94+
</div>
10195
</div>
10296
</div>
103-
<div className="col col--6">
97+
<div className="max-md:hidden">
10498
<div className="hero-image">
10599
<img src={siteConfig.customFields.logo} alt="hero-img" />
106100
</div>

Diff for: website/src/components/home/features/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ function Rollout() {
8282
</ul>
8383
</div>
8484
</div>
85-
<div className={clsx(styles.imgRollout)}>
85+
<div className={clsx(styles.imgRollout, 'max-md:hidden')}>
8686
<div className={styles.featureImage}>
8787
<img
8888
src="img/features/rollout.png"

0 commit comments

Comments
 (0)