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] Refactor and update build/install guide #1895

Closed
cjnolet opened this issue Oct 12, 2023 · 0 comments · Fixed by #1899
Closed

[DOC] Refactor and update build/install guide #1895

cjnolet opened this issue Oct 12, 2023 · 0 comments · Fixed by #1899
Assignees
@cjnolet
Labels
doc Documentation

Comments

@cjnolet
Copy link
Member

cjnolet commented Oct 12, 2023 •
edited
Loading

@nwstephens has pointed out that our build guide has gotten both out of date and hard to follow. In addition, the examples and suggestions in the readme and build/install guide have diverged a bit. These definitely need some TLC.

We should probably remove the C++ build without cmake bits as more recent updates have made that near impossible to use in practice. We should also include everything in the build/install guide and then summarize a few bits directly in the readme instead of the other way around.
@cjnolet cjnolet added the doc Documentation label Oct 12, 2023
@cjnolet cjnolet self-assigned this Oct 12, 2023
@cjnolet cjnolet mentioned this issue Oct 13, 2023
Merged
rapids-bot bot pushed a commit that referenced this issue Oct 14, 2023
@cjnolet
Refactor install/build guide. (#1899)
cbcd4a0 
This PR makes some mcuh needed changes to the installation and builde guide. This PR also fixes a few APIs that were missing from the API docs. 

Closes #1895

Authors:
  - Corey J. Nolet (https://github.com/cjnolet)

Approvers:
  - Bradley Dice (https://github.com/bdice)
  - Dante Gama Dessavre (https://github.com/dantegd)

URL: #1899
divyegala pushed a commit to divyegala/raft that referenced this issue Oct 17, 2023
@cjnolet @divyegala
Refactor install/build guide. (rapidsai#1899)
c9c0966 
This PR makes some mcuh needed changes to the installation and builde guide. This PR also fixes a few APIs that were missing from the API docs. 

Closes rapidsai#1895

Authors:
  - Corey J. Nolet (https://github.com/cjnolet)

Approvers:
  - Bradley Dice (https://github.com/bdice)
  - Dante Gama Dessavre (https://github.com/dantegd)

URL: rapidsai#1899
divyegala pushed a commit to divyegala/raft that referenced this issue Oct 19, 2023
@cjnolet @divyegala
Refactor install/build guide. (rapidsai#1899)
be5848a 
This PR makes some mcuh needed changes to the installation and builde guide. This PR also fixes a few APIs that were missing from the API docs.

Closes rapidsai#1895

Authors:
  - Corey J. Nolet (https://github.com/cjnolet)

Approvers:
  - Bradley Dice (https://github.com/bdice)
  - Dante Gama Dessavre (https://github.com/dantegd)

URL: rapidsai#1899
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cjnolet cjnolet

Labels
doc Documentation
Projects
VS/ML/DM Primitives Release Board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Refactor install/build guide. cjnolet/raft
1 participant
@cjnolet