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

Added Release Notes Links To Release Information #9358

Merged

Conversation

BarnyShergold
Copy link
Contributor

@BarnyShergold BarnyShergold commented Feb 10, 2022

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.

@meker12
Copy link
Contributor

meker12 commented Feb 10, 2022

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.

2022-02-10_13-31-51

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.

@dshevtsov
Copy link
Collaborator

@BarnyShergold I converted it to draft until it is discussed within the Community guild.

@dshevtsov dshevtsov self-assigned this Feb 10, 2022
@meker12 meker12 removed their assignment Feb 10, 2022
Copy link
Collaborator

@dshevtsov dshevtsov left a 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 object releaseNotes 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": ... }
    

@BarnyShergold
Copy link
Contributor Author

@dshevtsov - Leave this with me

@BarnyShergold
Copy link
Contributor Author

@dshevtsov @dobooth
I think this achieves what was suggested? Where next?

@dshevtsov dshevtsov marked this pull request as ready for review February 15, 2022 18:31
Copy link
Collaborator

@dshevtsov dshevtsov 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. Thank you, @BarnyShergold!

@dshevtsov
Copy link
Collaborator

@magento import code to magento-devdocs/devdocs

@m2-github-services
Copy link

@dshevtsov the branch with the code is successfully imported into the magento-devdocs/devdocs repository. Branch name: imported-BarnyShergold-devdocs-9358.

@dshevtsov dshevtsov added the 2.x label Feb 15, 2022
@dshevtsov dshevtsov added the Technical Updates to the code or processes that alter the technical content of the doc label Feb 15, 2022
@magento-devops-reposync-svc magento-devops-reposync-svc merged commit 91c869e into magento:master Feb 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Progress: done Technical Updates to the code or processes that alter the technical content of the doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants