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

Append maintenance status per version #762

Merged
merged 1 commit into from
Jul 27, 2022
Merged

Append maintenance status per version #762

merged 1 commit into from
Jul 27, 2022

Conversation

tnir
Copy link
Collaborator

@tnir tnir commented Jul 26, 2022

What was the end-user problem that led to this PR?

A visitor cannot see what version is active while 10 minor versions are listed.

Closes #760

What was your diagnosis of the problem?

Looks good to start with indicating the maintenance status per version rubygems/rubygems#5647.

What is your fix for the problem, implemented in this PR?

Append the maintenance status per version next to each version in the version selector in the versioned man pages.

before after
bundler io_v2 3_man_bundle-viz 1 html v2-closed
version-selector v2-open
Previous version of screenshots after the change (only for reference)

bundler-site-tnir-versi-phrzrh herokuapp com_v2 3_man_bundle-install 1 html
version-selector-after

Why did you choose this fix out of the possible options?

No other option can be imagine...

Signed-off-by: Takuya Noguchi [email protected]

@deivid-rodriguez deivid-rodriguez temporarily deployed to bundler-site-tnir-versi-phrzrh July 26, 2022 05:26 Inactive
@tnir tnir added this to the Create missing parts milestone Jul 26, 2022
@tnir tnir self-assigned this Jul 26, 2022
@olleolleolle
Copy link
Member

One possible extension would be to use HTML optgroup elements to group the "maintenance levels".

lib/versions.rb Outdated Show resolved Hide resolved
@tnir
Copy link
Collaborator Author

tnir commented Jul 26, 2022

@deivid-rodriguez @hsbt Thoughts? cf. rubygems/rubygems#5647

Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

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

I think this is a good idea.

helpers/config_helper.rb Outdated Show resolved Hide resolved
@deivid-rodriguez deivid-rodriguez temporarily deployed to bundler-site-tnir-versi-phrzrh July 26, 2022 14:26 Inactive
@deivid-rodriguez
Copy link
Member

Ok with me, not sure if you plan to implement @olleolleolle's suggestion about html optgroup elements?

@tnir
Copy link
Collaborator Author

tnir commented Jul 26, 2022

@deivid-rodriguez Thanks.
@olleolleolle Which in the below CodePen do you expect or what else? Option 1 can hardly reduce feeling like too packed, but Option 2 cannot indicate the status of the version a user is seeing to them itself.
https://codepen.io/tnir/pen/BarwNOm

I am slightly inclined to choose Option 2 if we will go with a more notice in the main area (or in the fixed header) by #761.

@tnir tnir requested a review from hsbt July 26, 2022 15:04
@olleolleolle
Copy link
Member

To me, option 2 seems easier to understand.

@deivid-rodriguez deivid-rodriguez temporarily deployed to bundler-site-tnir-versi-phrzrh July 27, 2022 01:06 Inactive
@tnir tnir requested a review from olleolleolle July 27, 2022 01:06
@tnir
Copy link
Collaborator Author

tnir commented Jul 27, 2022

Thanks @olleolleolle for the preference! Happy to merge this and to improve the presentation in the main area in #761.

@tnir tnir removed the request for review from hsbt July 27, 2022 03:08
@tnir tnir merged commit f9ade69 into master Jul 27, 2022
@tnir tnir deleted the tnir-version-status branch July 27, 2022 03:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

State the status per minor versions
3 participants