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

Conda developer docs #36167

Merged

Conversation

robertapplin
Copy link
Contributor

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
  • 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?
  • Are the release notes saved in a separate file, using Issue or PR number for file name and in the correct location?
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 Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period. labels Sep 22, 2023
@robertapplin robertapplin added this to the Release 6.9 milestone Sep 22, 2023
@robertapplin robertapplin marked this pull request as ready for review September 22, 2023 13:01
@cailafinn cailafinn self-assigned this Sep 27, 2023
Copy link
Contributor

@cailafinn cailafinn 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, and nice to have this in. Just a few typo/style/etc. comments

dev-docs/source/CondaPackageManager.rst Outdated Show resolved Hide resolved
dev-docs/source/CondaPackageManager.rst Outdated Show resolved Hide resolved
dev-docs/source/CondaPackageManager.rst Outdated Show resolved Hide resolved
dev-docs/source/CondaPackageManager.rst Outdated Show resolved Hide resolved
dev-docs/source/CondaPackageManager.rst Outdated Show resolved Hide resolved
dev-docs/source/CondaPackageManager.rst Outdated Show resolved Hide resolved
dev-docs/source/index.rst Outdated Show resolved Hide resolved
@robertapplin
Copy link
Contributor Author

Thanks @ConorMFinn , its ready for another look

Copy link
Contributor

@cailafinn cailafinn 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 to me now. Nice work

@gemmaguest gemmaguest merged commit 0925e95 into mantidproject:main Oct 13, 2023
8 checks passed
@robertapplin robertapplin deleted the 35835-conda-developer-docs branch October 22, 2023 18:19
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 Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
Development

Successfully merging this pull request may close these issues.

3 participants