-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Added Release Notes Links To Release Information #9358
Added Release Notes Links To Release Information #9358
Conversation
Thanks for the PR @BarnyShergold. Looks great! I'll wait until you add the 2.3 stuff before completing the PR processing. Also, adding @jfrontain and @jeff-matthews as reviewers for awareness and any additional feedback. Also, you don't need to add links to version 2.2 release notes–it's out of support, and DevDocs doesn't include any 2.2 content. |
@BarnyShergold I converted it to draft until it is discussed within the Community guild. |
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.
We have to consider that the target purpose of the JSON file is API for automation. The purpose of maintaining the devdocs topic is secondary by priority. Considering this we should avoid introducing any data that can cause breaking changes.
"release-notes" : true
-- I don't think we need this field. I cannot recall any precedent when release notes did not exist for a released version, especially on a minor level. Anyway, even if this precedent will appear it still can be resolved programmatically."commerceReleaseNotes"
,"opensourceReleaseNotes"
,"combinedReleaseNotes"
-- considering a long history of migrations and rebranding I suggest we use an objectreleaseNotes
that contain absolute links such as:"releaseNotes": {"commerce": "https://devdocs.magento.com/guides/v2.4/release-notes/release-notes-2-4-0-commerce.html", "openSource": ..., "whatever": ... }
@dshevtsov - Leave this with me |
@dshevtsov @dobooth |
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. Thank you, @BarnyShergold!
@magento import code to magento-devdocs/devdocs |
@dshevtsov the branch with the code is successfully imported into the |
Purpose of this pull request
This pull request (PR) addresses issue #9355
Using an enhancement to the JSON file, the links to the Release notes can be added which will then display on the page.
A special value indicates if there are any release notes in the section so the table can be created with a third column
Currently only v2.4 has had links added. If the solution is approved, then I will add 2.3 & 2.2 release note links to the PR for approval
Affected DevDocs pages
https://devdocs.magento.com/release/released-versions.html
Screenshot
https://capture.dropbox.com/pj2P8gznSBrsQdmo?src=ss
whatsnew
Added release notes data to
src/_data/core-releases.json
and Released versions.