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

Restructure features documentation #8394

Merged
merged 21 commits into from
Oct 16, 2024
Merged

Conversation

melindafekete
Copy link
Collaborator

@melindafekete melindafekete commented Oct 8, 2024

About the changes

Reorganize, update, and improve concepts documentation around feature flags.

This PR merges all feature flag-related concepts pages into a single page. This helps the discoverability of all closely related topics and helps tie together these concepts through explanations between the different sections.

Previously:

Are now all on:

Additionally, removed the deprecated Feature Flag Variants from the navigation, now only referenced at the bottom of the strategy variants page. Also, I removed the how to create a naming pattern guide, as it covers the same information as the concepts docs, and there is not enough specific content to fill a standalone guide.

@melindafekete melindafekete self-assigned this Oct 8, 2024
Copy link
Contributor

github-actions bot commented Oct 8, 2024

Dependency Review

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

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

Copy link

vercel bot commented Oct 8, 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 15, 2024 4:35pm
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 4:35pm

Correct lifetime value
Copy link
Contributor

@gastonfournier gastonfournier left a comment

Choose a reason for hiding this comment

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

Good job with the redirects!

@@ -291,7 +291,7 @@ Generated when you drop all existing tags as part of a configuration import. The

#### `feature-potentially-stale-on`

Generated when Unleash marks a feature flag as potentially stale due to exceeding the expected lifetime of its [feature flag type](/reference/feature-toggle-types). `preData` and `data` are null.
Generated when Unleash marks a feature flag as potentially stale due to exceeding the expected lifetime of its [feature flag type](/reference/feature-toggles#feature-flag-types). `preData` and `data` are null.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Generated when Unleash marks a feature flag as potentially stale due to exceeding the expected lifetime of its [feature flag type](/reference/feature-toggles#feature-flag-types). `preData` and `data` are null.
Generated when Unleash marks a feature flag as potentially stale due to exceeding the expected lifetime of its [feature flag type](/reference/feature-toggles#feature-flag-types). `preData` and `data` are `null`.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Why do you suggest code formatting for this? Given that it's an unrelated change, and there are many occurrences of it, let's tackle it separately

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.

Nice one 🔥

Good work on getting the OpenAPI changes in too 🙌🏼

A couple small questions, but no blockers. Solid effort 💯


## Environment level variants

[Environment level variants](./feature-toggle-variants) are deprecated. Use strategy variants instead.
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 have a deprecation notice on the old variants doc page?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes

Comment on lines 354 to +355
from: '/advanced/archived_toggles',
to: '/reference/archived-toggles',
to: '/reference/feature-toggles',
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably update all the relevant redirects to target the new page.

It'll be (I think):

from: ['/advanced/archived_toggles', '/reference/archived-toggles']
to: '/reference/feature-toggles'

Also, don't we do this server-side now? 🤔

So this goes for this one and all the other deleted files (I noticed there's only two redirects here, but you've deleted at least 6 files)

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, but I see you've also updated the vercel file, which should take care of it. In that case, are the changes here still necessary?

Copy link
Collaborator Author

@melindafekete melindafekete Oct 16, 2024

Choose a reason for hiding this comment

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

Yes, I added the new redirects in Vercel, these are some legacy ones. I am not sure if these '/advanced' pages are still getting any traffic. Eventually, all redirects should be in Vercel, but I wanted to tackle this separately, as we might not need to move all of them.

We should probably update all the relevant redirects to target the new page.

I am pointing these legacy pages to the new page too, unless I am missing something 🤔

@melindafekete melindafekete merged commit c580e76 into main Oct 16, 2024
12 of 14 checks passed
@melindafekete melindafekete deleted the melinda/features-docs-reorg branch October 16, 2024 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants