-
Notifications
You must be signed in to change notification settings - Fork 7
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
Conversation
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.
🎊 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 |
There was a problem hiding this 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."
I will integrate @ugaston feedback soon. |
Quality Gate passedIssues Measures |
There was a problem hiding this 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!
Perfect |
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
Inspirations
Inspired by the Posgres documentation: https://www.postgresql.org/docs/11/app-createdb.html
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