[DOC] RAPIDS -> nvidia docs migration TODOs
Open
Nobody has claimed this yet.
doc
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
As part of the migration of docs from docs.rapidsai to docs.nvidia there are a few task that need to happen
- Fix/remove broken rapids logo in README
- Remove references to RAPIDS in README (if used in front of a library like RAPIDS RAFT replace for NVIDIA raft)
- Remove links references to RAPIDS community - currently showing in main page under https://docs.nvidia.com/cuvs/home#useful-resources and in README
- Fix link this link https://github.com/NVIDIA/cuvs/blob/c740818bc68c58e5141c0eb2f832f26cfd9288bd/README.md?plain=1#L85 in README to point to the corresponding docs in nvidia page
- In https://github.com/NVIDIA/cuvs/blob/c740818bc68c58e5141c0eb2f832f26cfd9288bd/fern/pages/build.md?plain=1#L9 you are pointing to https://rapids.ai/start.html#wsl2 this page doesn't exist anymore, temporarily you can point to https://docs.rapids.ai/install/#wsl2 which will be redirected to a page in docs.nvidia in the near future. That being said, you might want to find instructions for WSL2 moving forward that are cuvs targeted. (cc @taureandyernv in case you have better guidance)
- Replace any reference to libraries in the docs, like RAPIDS to NVIDIA
- If there are links to docs, make sure to point them to nvidia docs page not rapids docs page.
- Fore repositories you can follow something like https://github.com/rapidsai/deployment/pull/752#issue-5388961059
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.md and fern/pages/build.md, then review the linked cuVS documentation page and the docs.nvidia.com/cuvs/home resources. Trace each checklist item through the README and Fern docs, checking for broken RAPIDS branding and links. Done means the listed references and links are updated or removed, with WSL2 guidance pointing to the specified destination.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100