Add an alert to point users to the correct relese notes. #245
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@VaishnaviHire @zdtsw ^^ |
zdtsw
reviewed
Oct 9, 2024
src/templates/docs-page.tsx
Outdated
| @@ -41,6 +41,11 @@ const DocsPageTemplate = ({ | |||
| isWidthLimited | |||
| padding={{ default: "padding" }} | |||
| > | |||
| <Alert variant="info" title="Important Notice" isInline className="pf-u-mb-xl"> | |||
| <p> | |||
| Please note that the latest information about release notes has been moved <a href="https://github.com/opendatahub-io/opendatahub-operator/releases/latest" target="_blank" rel="noopener noreferrer">here</a>. | |||
There was a problem hiding this comment.
maybe something more like if want to checkout previous v2 releases, go https://github.com/opendatahub-io/opendatahub-operator/releases and use "find release" to search for?
AjayJagan
force-pushed
the
add-notice-release-notes
branch
from
f0854cc
to
f4a640f
Compare
AjayJagan
force-pushed
the
add-notice-release-notes
branch
from
f4a640f
to
c236d41
Compare
zdtsw
approved these changes
Oct 10, 2024
|
i am fine with the change, just needs another eyes on it |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provide a message to users about the latest release notes.
Description
After some discussion with the team, it seems that the information about a release should have a singe source of truth and that being the https://github.com/opendatahub-io/opendatahub-operator/releases/latest.
So the idea is to provide a useful notice to the users so that they can navigate to the correct one.
How Has This Been Tested?
Merge criteria: