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.

Sign up for GitHub

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

Jump to bottom

[DOC]: Update Contributing.md guide with latest build instructions #1737

Closed
7 tasks
mdemoret-nv opened this issue Jun 14, 2024 · 0 comments · Fixed by #1924
Closed
7 tasks

[DOC]: Update Contributing.md guide with latest build instructions #1737

mdemoret-nv opened this issue Jun 14, 2024 · 0 comments · Fixed by #1924
Assignees
@dagardner-nv
Labels
doc Improvements or additions to documentation
Milestone
24.10 - Release

Comments

@mdemoret-nv
Copy link
Contributor

mdemoret-nv commented Jun 14, 2024 •
edited by yczhang-nv
Loading

Update the contributing guide and any documentation related to building Morpheus.

Completion Criteria

  • Review all guides related to building Morpheus or getting started with Morpheus
    • Each method should be tested from a clean clone of the repository to ensure it is accurate and there are no errors
  • Run the docker build scripts for both development and release
    • For both containers that are generated, ensure that all tests run inside the container. Fix any bugs or update the docs
  • Add a section to the contributing docs about getting started with Morpheus via the dev container
  • Update the troubleshooting section with any problems that may occur
  • Ensure the contributing guide is organized well and has proper sections
@mdemoret-nv mdemoret-nv added the doc Improvements or additions to documentation label Jun 14, 2024
@yczhang-nv yczhang-nv mentioned this issue Jun 14, 2024
Closed
@morpheus-bot-test morpheus-bot-test bot moved this from Todo to Review - Ready for Review in Morpheus Boards Jun 14, 2024
@dagardner-nv dagardner-nv moved this from Review - Ready for Review to In Progress in Morpheus Boards Oct 1, 2024
@dagardner-nv dagardner-nv mentioned this issue Oct 1, 2024
Merged
@morpheus-bot-test morpheus-bot-test bot moved this from In Progress to Review - Ready for Review in Morpheus Boards Oct 1, 2024
@mdemoret-nv mdemoret-nv added this to the 24.10 - Release milestone Oct 18, 2024
rapids-bot bot pushed a commit that referenced this issue Oct 18, 2024
@dagardner-nv
Update documentation to reflect CPU-only execution mode (#1924)
47841d6 
* Documents writing a stage that supports CPU execution mode
* Updates `docs/source/developer_guide/contributing.md` cleaning up build and troubleshooting sections. 

Requires PRs #1851 & #1906 to be merged first

Closes [#1737](#1737)

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md).
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)
  - Yuchen Zhang (https://github.com/yczhang-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #1924
@github-project-automation github-project-automation bot moved this from Review - Ready for Review to Done in Morpheus Boards Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dagardner-nv dagardner-nv

Labels
doc Improvements or additions to documentation
Projects
Morpheus Boards
Status: Done
Milestone
24.10 - Release
Development

Successfully merging a pull request may close this issue.

Update documentation to reflect CPU-only execution mode dagardner-nv/Morpheus
3 participants
@mdemoret-nv @dagardner-nv @yczhang-nv