-
Notifications
You must be signed in to change notification settings - Fork 124
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
Conda developer docs #36167
Conda developer docs #36167
Conversation
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, and nice to have this in. Just a few typo/style/etc. comments
f08c0c3
to
2b98901
Compare
Thanks @ConorMFinn , its ready for another look |
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 now. Nice work
Description of work
This PR adds a developer documentation page on how the Conda package manager can be used in Mantid. It provides tips on debugging dependency issues in our pipelines, and recommendations on how they should be fixed. It also includes a policy on our attitude towards using PyPi packages in Mantid (we strongly recommend that we do not).
This PR doesn't add all the Conda documentation we probably need. I have left some checklist points in the attached issue which would benefit from being written from other team members with experience in these areas. But I think this document makes a good start and can be added to in the future.
To test:
Code review. Build dev-docs target and make sure the links are working.
Part of #35835
This does not require release notes because it is dev docs
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
Functional Tests
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.