open-feature / openfeature.dev Goto Github PK

If I'm new to OpenFeature (as I currently am), I want the high level concept immediately.

This issue proposes that we simplify this graphic and include it right there on the homepage.

Very rough (and possibly technically incorrect!) examples:

Requirements

postcss ^8.4.22 → ^8.4.23

Explain what they're for and how to use them.

Change in the documentation

Add a section in the docs that highlights the OpenFeature ecosystem.

This should include:

• All the vendors and tools that have OpenFeature providers and for what language
• An overview of every OpenFeature SDK, what's the latest version, and what level of the spec is it compliment with
• All the hooks and extensions that are available.

Examples:

• https://opentelemetry.io/ecosystem/

Follow-up

• Include a link from the main landing page to the ecosystem page.

@types/jest ^29.2.3 → ^29.2.4
@types/node ^18.11.9 → ^18.11.11
@types/react ^18.0.25 → ^18.0.26
react-router-dom ^6.4.3 → ^6.4.4

Should include:

• Linkedin
• Twitter

We should add a tutorial for installing the operator and using flagd for flag evaluation.

OpenFeature will provide a unified API and SDK, and a developer-first, cloud-native implementation, with extensibility for open source and commercial offerings.

Change this slightly to be less ambiguous. OpenFeature provides a unified.... not will, it does.

@testing-library/react ^13.4.0 → ^14.0.0
@types/jest ^29.2.4 → ^29.4.0
@types/node ^18.11.12 → ^18.14.6
@types/react ^18.0.26 → ^18.0.28
@types/react-dom ^18.0.9 → ^18.0.11
react-router-dom ^6.4.5 → ^6.8.2
sass ^1.56.2 → ^1.58.3
typescript ^4.9.4 → ^4.9.5

Overview

The OpenFeature website is a basic landing page that contains a collection of external links. This can be annoying to users that want to understand what the project is all about without having to dig into the documentation. It also uses terminology such as "cloud native" that may be confusing to users unfamiliar with the concept.

Proposal

Redesign the main landing page of the website. It should consider the first-time user experience and present answers to commonly asked questions.

It should answer the following questions:

• What is a feature flag?
• What problem does OpenFeature solve?
• What vendors support OpenFeature?
• How do I get started?

As part of the redesign, the website and docs should be consolidated. The domain docs.openfeature.dev should be deprecated and redirect to a corresponding openfeature.dev link.

Examples landing pages

Remix

The Remix landing page does an excellent job explaining that Remix is and the value it providers.

Go Feature Flag

Thomas did a great job building the Go Feature Flag landing page. He customized the Apsho Hugo template.

@types/react ^18.0.31 → ^18.0.33
react-router-dom ^6.9.0 → ^6.10.0
web-vitals ^3.3.0 → ^3.3.1

Change in the documentation

open-feature/go-sdk#163 changes the Hooks API, absorb this where necessary.

I would like to edit the link on the landing page to send to our mailchimp newsletter.

Requirements

The logos on the landing page should be clickable to a user can quickly navigate from the main page to the topic they're interested in. For example, if the user is interested in learning more about a vendor, they could click the logo and navigate to the dedicated page in the ecosystem. If a user clicks one of the language logos, it could navigate them to the appropriate spot in the docs.

One the spec update and web-sdk implementation is complete, we should update the docsite to include concepts around client side. We may want a high-level section on server vs client differences, and some code comparisons between the js/web SDKs. We could also reference Pete's blog post: https://docs.openfeature.dev/blog/catering-to-the-client-side

add doc about evaluation context merging (global, client) now that's in the spec.

Requirements

@types/react ^18.0.33 → ^18.0.35
sass ^1.61.0 → ^1.62.0

Change in the documentation

Create a getting started tutorial for PHP. The JavaScript tutorial can be used as a reference.

Change in the documentation

Create a new section in the docs that focuses on development.

The structure could like something like this:

• Development
  • Integrations
    • Providers
    • Hooks
  • Contributing

The implementing provider section that currently lives under concepts should be moved to the new location. The implementing hooks section should be moved to the new location and expanded.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

• fix(deps): update dependency clsx to v2.1.1

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency typescript to v5.4.5
• fix(deps): update dependency @headlessui/react to v1.7.19
• fix(deps): update dependency react-instantsearch to v7.7.2
• chore(deps): update dependency dev.openfeature.contrib.providers:flagd to v0.8.0
• chore(deps): update dependency eslint-plugin-check-file to v2.8.0
• chore(deps): update typescript-eslint monorepo to v7.7.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(deps): update dependency sass to v1.75.0
• chore(deps): update dependency eslint to v9
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency node to 18.20
• chore(deps): update dependency eslint-plugin-jest to v28
• chore(deps): update dependency node to v20

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Short Abstract

Consolidate the documentation for the various sub-projects and SDKs that make up OpenFeature. This will provide a one stop shop for users to learn about the project and how they can use it in their environment.

Why

The OpenFeature documentation is currently distributed across various repos in the OpenFeature GitHub org. This can make it difficult for new users to discover what's available and how it can be used. Consolidating documentation will allow users to search for what they need across the entire project.

Functional Requirements

Develop a strategy for consolidating documentation that may be distributed across multiple repos. This allows devs to include doc changes in their normal workflow and have them promoted automatically to the centralized doc.

Non-Functional Requirements

• Existing links must continue to work or be redirected to an appropriate replacement page.
• Contributing guide must help users understand how they can contribute to the docs.

Change in the documentation

Create a getting started tutorial for .NET. The JavaScript tutorial can be used as a reference. The .NET flagd provider can be found here.

The existing community link points to a GitHub repo which then sends me to https://github.com/open-feature/.github/blob/main/CONTRIBUTING.md

But I'm still left wondering how I get involved, contribute and (for example) raise issues or enhancement requests and then how do they get assigned to me if I want to contribute.

Change in the documentation

https://docs.openfeature.dev/docs/tutorials/ofo includes installation of OFO via the manifest, but doesn't mention helm.

We should enhance this to include a helm section, and talk about some of the interesting configuration options.

Requirements

https://peps.python.org/ <- I basically want these for OFEPs

The community link on openfeature.dev points to Github.com/open-feature/community

Now that https://docs.openfeature.dev/community is available, the link should point there instead.

Change in the documentation

It is confusing when looking at the blog posts in the file tree, which are not chronological ordered.

They're currently named like dd-mm-yyyy-title, and therefore they're ordered by day of the month.

Instead, we should rename all of them to yyyy-mm-dd-title. This makes it easier to look at them and also reflects the rendering on the page - hence that makes it easier to find them.

I did not open a pull request with this suggestions, as there are currently 2 open prs affecting blog posts, and i did not want to create unnecessary conflicts.

@types/jest ^29.4.0 → ^29.4.1
@types/node ^18.14.6 → ^18.15.3
react-router-dom ^6.8.2 → ^6.9.0
sass ^1.58.3 → ^1.59.3
web-vitals ^3.1.1 → ^3.3.0

form more secure

Change in the documentation

Once open-feature/open-feature-operator#207 and open-feature/flagd#205 are merged, we should update the OFO tutorial:

• update the tutorial with helm instructions
• update the samples in the playground to use the new v2alpha definition

I'm happy to do this unless somebody else wants to.

cc @skyerus @AlexsJones

Include additional information on the readme

• Intro
• Contributing
• License

Link directly to: https://cloud-native.slack.com/archives/C0344AANLA1 from website topbar next to LinkedIn and Twitter

add link

• should do general spell-checking
• should allow us to add custom words and enforce them (ie: "OpenFeature" is right, "Openfeature" is not)

No one shows up to this landing page and thinks "Man, I'm glad that after I clicked that link.. I can go back to this functionally empty marketing page". Make those header links not open in a new window. :)

Change in the documentation

Add this link: https://killercoda.com/open-feature/scenario/five-minutes-to-feature-flags to this page: https://openfeature.dev/docs/tutorials/five-minutes-to-feature-flags

Requirements

@typescript-eslint/eslint-plugin 5.59.0 → 5.59.1
@typescript-eslint/parser 5.59.0 → 5.59.1

#24 (comment)

The two buttons on the home page are accessible, but not highlighted when in focus. Need to attach focus styling for the buttons.

Change in the documentation

The specification section is currently added via a custom logic, but there is also a way to add it with a default docusaurus way.

The docusaurus way is easier to handle, as it contains no custom logic and works well with menus, and is purely configuration based. see https://docusaurus.io/docs/docs-multi-instance

Our current implementations relies on https://github.com/open-feature/docs.openfeature.dev/blob/main/src/plugins/external-content.js

I will fix it soon

Requirements

A user was interested enough in the project to scroll through the entire landing page. We could reward them with a call to action 😄. This could be a form to sign up for the newsletter, another "Get started" button, or something else.

As an end-user considering adopting or advocating for OpenFeature, I need to have confidence that my tooling vendors are "available" in OpenFeature.

As a tooling vendor, I want to promote that it's easy to adopt my tooling whilst your organisation's code remains vendor agnostic.

Both of the above would benefit from a graphic / list somewhere on the doc site of Providers who have current and maintained integrations.

• update spec link to docs spec
• add docs link
• learn more -> https://docs.openfeature.dev/docs/reference/intro
• remove roadmap
• top bar order is:
  Overview
  Documentation
  Specification
  Community
  GitHub
• update Mission statement

The Linux Foundation (LD) require that a badge is added to the footer of the website.

cncf/toc#857

ensure LF footer is there and [website guidelines](https://github.com/cncf/foundation/blob/master/website-guidelines.md) followed (if your project doesn't have a dedicated website, please adopt those guidelines to the README file of your project on GitHub).

SDK

.NET

Maintainer

Community

Artifacts

We need to add https://www.nuget.org/packages/OpenFeature.Contrib.Hooks.Otel to the docs here: https://docs.openfeature.dev/docs/reference/technologies/server/dotnet

DoD:

• dotnet OTel hooks shows up under hooks at https://docs.openfeature.dev/docs/reference/technologies/server/dotnet/

see similar PR

Repository

https://github.com/open-feature/dotnet-sdk-contrib/tree/main/src/OpenFeature.Contrib.Hooks.Otel

Anything else?

No response

Overview

People interested in using OpenFeature need a basic end-to-end tutorial that explains how to use OpenFeature in any language with an SDK.

Requirements

• Getting started tutorial for JS
• Getting started tutorial for Java
• Getting started tutorial for PHP
• Getting started tutorial for Go
• Getting started tutorial for .NET