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

Categories: add version support warnings to old versions #1251

Merged
merged 2 commits into from
Oct 13, 2024

Conversation

timmywil
Copy link
Member

@timmywil timmywil commented Sep 29, 2024

  • also made formatting consistent for all deprecated/version categories

The styling for the warning messages is in the companion PR in jquery-wp-content (some of the styling already existed). I prefer to set these explicitly rather than try to generate them programmatically. And, this gives us a little side advantage of being able to modify the message for specific categories, if needed. I made use of that when there were multiple versions and pluralized the message.

Ref jquery/jquery-wp-content#468
Ref jquery/jquery-wp-content#462

- also made formatting consistent for all deprecated/version categories
categories.xml Show resolved Hide resolved
categories.xml Show resolved Hide resolved
@Krinkle
Copy link
Member

Krinkle commented Oct 1, 2024

I'm unsure about the banner on "version added" category pages. These predominantly contain pages about features that continue to exist in even the latest beta with no hint or sign that they're not fit for use. Warning there seems deceptive and may confuse/break navigation flows and curiosity, specifically relating to how stable and mature something is based on when it was first added ("can I use").

+1 for adding to categories about deprecated and removed versions, which describes features in older versions indeed.

@joeeames
Copy link

joeeames commented Oct 2, 2024

Hey @Krinkle great point! something we didn't consider. the deprecated pages are about things that are out of date, but these pages aren't. BUT it is true that for example, the 1.2 page, is still a page about "1.2" which is EOL itself, although it's noting the API's added, most of which are still fine.

What do you think about instead of removing the banner, just changing the wording to say "This version is EOL, although the API's added are not necessarily EOL" or something to that effect?

@timmywil
Copy link
Member Author

timmywil commented Oct 5, 2024

I considered that, but since you brought it up as well. Let me think on the wording and I'll make a proposal soon.

@timmywil
Copy link
Member Author

timmywil commented Oct 6, 2024

I changed the version category pages to say this instead:

Some APIs may have changed since this version was released. If using this version, find out about our version support.

@mgol
Copy link
Member

mgol commented Oct 6, 2024

I changed the version category pages to say this instead:

Some APIs may have changed since this version was released. If using this version, find out about our version support.

It still doesn't fully feel right to me. The same sentence would make sense on version 3.7 as well once 4.0 gets released, even though we haven't removed support for this version. Unless you'd add such a banner on all 3.x versions as well as soon as 4.0.0 is out?

@timmywil
Copy link
Member Author

timmywil commented Oct 7, 2024

Unless you'd add such a banner on all 3.x versions as well as soon as 4.0.0 is out?

That was the idea, yeah. When 4.0.0 is released, we'd add a similar notice to 3.x versions.

@mgol
Copy link
Member

mgol commented Oct 7, 2024

That was the idea, yeah. When 4.0.0 is released, we'd add a similar notice to 3.x versions.

OK, cool, that works for me then.

@timmywil timmywil merged commit 85ed300 into jquery:main Oct 13, 2024
3 checks passed
@timmywil timmywil deleted the hero-devs branch October 13, 2024 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants