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

feat(out-of-support): make the message clearer #234

Merged
merged 5 commits into from
Sep 4, 2024

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Aug 21, 2024

Also remove the link to the downloads page are it doesn't relate to the documentation but to the
products themselves.

Here, we want to warn the reader about an outdated documentation content, not about its usage of
an out-of support product.

Proposals

previous implementation 179a073 e09219b
previous proposition_01 proposition_02

Inspirations

Inspired by the Posgres documentation: https://www.postgresql.org/docs/11/app-createdb.html

image

Reviews

I'm waiting for the feedback I've requested from people who use out of support content or who are in contact with customers using such content:

ℹ️ Test page: https://bonitasoft-bonita-documentation-theme-build_preview-pr-234.surge.sh/msg-block-out-of-support.html

Also remove the link to the downloads page are it doesn't relate to the documentation but to the
products themselves.

Here, we want to warn the reader about an outdated documentation content, not about its usage of
an out-of support product.
@tbouffard tbouffard added the enhancement New feature or request label Aug 21, 2024
src/partials/toolbar.hbs Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Aug 21, 2024

🎊 PR Preview 721d94a has been successfully built and deployed to https://bonitasoft-bonita-documentation-theme-build_preview-pr-234.surge.sh

🕐 Build time: 0.009s

🤖 By surge-preview

Copy link

@ugaston ugaston left a comment

Choose a reason for hiding this comment

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

Since we are also updating the link so it points to the latest version of the same page (instead of pointing to the home page of the latest version), I would have a slight preference for the other wording you suggested, because I feels more straightforward and less ambiguous, that is:

"You may want to view the same page for the latest version instead."

Furthermore, I would go all the way in copycatting PostgreSQL documentation, and also add a little message letting people know they can choose to view any other version of the same page by clicking on the corresponding link in the drop-down menu at the top-right corner. Something like:

"You may want to view the same page for the latest version instead, or for any of the versions available in the drop-down menu at the top-right corner."

@tbouffard
Copy link
Member Author

I will integrate @ugaston feedback soon.

Copy link

@tbouffard
Copy link
Member Author

To review @ugaston proposal

Commit: 721d94a

Large screens

image

Small screens prior switching to mobile view

⚠️ may conflict with changes proposed in #233

image

Copy link

@ugaston ugaston left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Thank you, Thomas!

@tbouffard
Copy link
Member Author

Perfect
I am waiting for the review of a maintainer of the repo to be able to merge this.

@tbouffard tbouffard marked this pull request as ready for review August 28, 2024 16:20
@benjaminParisel benjaminParisel merged commit ad7cd47 into master Sep 4, 2024
3 checks passed
@benjaminParisel benjaminParisel deleted the feat/improve_out_of_support_message branch September 4, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

Successfully merging this pull request may close these issues.

3 participants