rapidsai / rapidsai/docs

[DOC] add link to troubleshooting in Install selector tool

Open
#490 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

? - Needs Triage doc
Dominant language
HTML
Stars
52
Forks
73
Avg merge
4d 16m
Merged PRs (30d)
8

Description

Report needed documentation

Describe the documentation you'd like

The selector tool (https://docs.rapids.ai/install#selector) for installing RAPIDS is great. In https://github.com/rapidsai/docs/pull/488#issuecomment-1975209463 there was a little discussion about where would be best to put some of the troubleshooting advice for CUDA version for a conda install e.g. https://docs.rapids.ai/install#system-req or https://docs.rapids.ai/install#troubleshooting. I'm still not sure on where is the best location but one thing I think may help would be a link in the selector to the troubleshooting section after the copy button. However, there may be a need for duplicated documentation if it takes to you separate sections e.g. conda and docker which isn't ideal.

Screenshot 2024-03-03 at 1 30 56 PM

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the install selector tool at docs.rapids.ai/install#selector and compare the existing system-req and troubleshooting sections. Determine the best destination for troubleshooting advice, then add a selector link after the copy button and verify that the relevant guidance is reachable without unnecessary duplication.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.