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

Write index release note page for v6.9 #36856

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Feb 15, 2024

Description of work

This PR adds the highlights of v6.9 to the release note index page. It also updates the image - in this case it is a small collage of two of the new algorithms added to Mantid.

To test:

Check the index page for any mistakes. Make sure the image is rendered as expected.

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@robertapplin robertapplin added the Documentation Issues and pull requests related to documentation label Feb 15, 2024
@robertapplin robertapplin added this to the Release 6.9 milestone Feb 15, 2024
@robertapplin robertapplin changed the base branch from main to release-next February 15, 2024 13:20
@robertapplin robertapplin marked this pull request as ready for review February 15, 2024 16:36
Copy link
Contributor

@backmari backmari left a comment

Choose a reason for hiding this comment

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

Other than the one comment about the warning, the index page looks good to me! The links are working, except for two that I believe will be generated on the release date: the DOI for the release and the GitHub release page.

docs/source/release/v6.9.0/index.rst Outdated Show resolved Hide resolved
@sf1919 sf1919 merged commit cf4c390 into mantidproject:release-next Feb 16, 2024
9 checks passed
@sf1919
Copy link
Contributor

sf1919 commented Feb 16, 2024

DOI and Github release links will be sorted out at release as you correctly summise @backmari :)

I'm happy so I will get this merged in.

@robertapplin robertapplin deleted the 0-write-index-release-note-page-6-9 branch May 17, 2024 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants