Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add note cache is no longer experimental #547

Closed
wants to merge 5 commits into from
+5 −5
Closed

feat: add note cache is no longer experimental #547

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
840e7fe
feat: add note cache is no longer experimental
adriantam Nov 7, 2023
26239a6
update wording
adriantam Nov 7, 2023
ee027db
Merge branch 'main' into remove_experiment_cache
adriantam Nov 7, 2023
5a23f6f
Merge branch 'main' into remove_experiment_cache
adriantam Dec 1, 2023
f68c32f
Merge branch 'main' into remove_experiment_cache
adriantam Dec 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/content/getting-started/setup-openfga/docker-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,11 +476,11 @@ docker run -p 8080:8080 -p 8081:8081 openfga/openfga -e OPENFGA_EXPERIMENTALS="f

The following table enumerates the experimental flags, a description of what they do, and the versions of OpenFGA the flag is supported in:

| Name | Description | OpenFGA Version | Status |
|-------------------|--------------------------------------------------------------------|-----------------------|----------------------------|
| otel-metrics | Enables support for exposing OpenFGA metrics through OpenTelemetry | `0.3.2 <= v < v0.3.5` | became default in `v0.3.5` |
| list-objects | Enables ListObjects API | `0.2.0 <= v < v0.3.3` | became default in `v0.3.3` |
| check-query-cache | Enables caching of check subproblem result | `1.3.1 <= v ` | currently experimental |
| Name | Description | OpenFGA Version | Status |
|-------------------|--------------------------------------------------------------------|-----------------------|-------------------------------|
| otel-metrics | Enables support for exposing OpenFGA metrics through OpenTelemetry | `0.3.2 <= v < v0.3.5` | became default in `v0.3.5` |
| list-objects | Enables ListObjects API | `0.2.0 <= v < v0.3.3` | became default in `v0.3.3` |
| check-query-cache | Enables caching of check subproblem result | `1.3.1 <= v < v1.3.6` | became supported from `v1.3.6`|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here and above, I'm not sure what this is supposed to mean. I wonder if we can drop the "Status" column in favor of just the explicit version range?

An experimental flag is present in a release until we remove it. Once we remove it I wouldn't say it is "defaulted", because it is is gone. It no longer is interpreted in any way by the server. So I think it is less confusing if we just say the range of OpenFGA server versions that the experimental flag existed in.

WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree - I have trouble coming up with what to write in the status section. What do you think @rhamzeh ?



:::caution Warning
Expand Down