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.

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

Align availability information in the docs #8177

Merged
merged 8 commits into from
Oct 3, 2024

Conversation

melindafekete
Copy link
Collaborator

@melindafekete melindafekete commented Sep 18, 2024

About the changes

This PR standardizes the way we show version and plan requirements in the docs. It introduced consistent wording and formatting, so readers can see the requirements at a glance. When a feature is only Enterprise or Pro, the version requirement leads to the pricing page.

This Notion page documents the guidelines with some examples.

Here is a sample of a few pages covering different scenarios:

Copy link

vercel bot commented Sep 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 3:55pm
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 3:55pm

@melindafekete melindafekete changed the title Align availability information in the docs [WIP] Align availability information in the docs Sep 18, 2024
Copy link
Contributor

github-actions bot commented Sep 18, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

website/docs/reference/insights.mdx Outdated Show resolved Hide resolved
website/docs/reference/integrations/datadog.md Outdated Show resolved Hide resolved
website/docs/reference/integrations/teams.md Outdated Show resolved Hide resolved
website/docs/reference/stickiness.md Outdated Show resolved Hide resolved
website/docs/reference/stickiness.md Outdated Show resolved Hide resolved
website/docs/using-unleash/deploy/email-service.md Outdated Show resolved Hide resolved
website/docs/using-unleash/deploy/email-service.md Outdated Show resolved Hide resolved
# Conflicts:
#	website/docs/how-to/how-to-set-up-group-sso-sync.md
#	website/docs/how-to/how-to-setup-sso-keycloak-group-sync.md
#	website/docs/reference/feature-lifecycle.md
website/docs/reference/scim.md Outdated Show resolved Hide resolved
website/docs/how-to/how-to-setup-provisioning-with-okta.md Outdated Show resolved Hide resolved
website/docs/reference/actions.md Outdated Show resolved Hide resolved
website/docs/reference/signals.md Outdated Show resolved Hide resolved
website/docs/reference/projects.md Outdated Show resolved Hide resolved
@melindafekete melindafekete changed the title [WIP] Align availability information in the docs Align availability information in the docs Oct 1, 2024
Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

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

Verrrry nice 🙌🏼 🔥 Got a few questions and comments in there, but nothing super important. Check them out and see what you think.

website/docs/how-to/how-to-enable-openapi.mdx Outdated Show resolved Hide resolved
website/docs/how-to/how-to-environment-import-export.mdx Outdated Show resolved Hide resolved
website/docs/reference/actions.md Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

All the notes in this file appear to use the same version number; shouldn't we then just use one availability note?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Do you know if there is any reason why the current docs specifically say:

The following three sections: "Application Overview," "Connected Instances," and "Project Applications" were released in Unleash 5.11.

I think that's what got me confused

website/docs/reference/environments.md Outdated Show resolved Hide resolved
@@ -574,12 +574,6 @@ This event fires when you drop all existing tags as part of a configuration impo

### `feature-potentially-stale-on`
Copy link
Contributor

Choose a reason for hiding this comment

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

do we not want to put event availibility in? this was released at some point, but not available to users previously. I wonder if that's useful info or not?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Do you mean for events in general or this feature-potentially-stale-on event in particular?

website/docs/understanding-unleash/proxy-hosting.mdx Outdated Show resolved Hide resolved
Co-authored-by: Thomas Heartman <thomas@getunleash.io>
Remove environments 4.2 statement
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants