dmlc / dmlc/xgboost

Simplify installation doc

Open
#5,282 0 comments 6 reactions 0 assignees View on GitHub
doc feature-request
Dominant language
C++
Stars
28.8k
Forks
8.9k
Avg merge
1d 12h
Merged PRs (30d)
54

Description

The current installation doc (https://xgboost.readthedocs.io/en/latest/build.html) has accumulated lots of sections over time. It's time to simplify it. I want to make it look simple and easy to use.

Good examples:
* RAPIDS: https://rapids.ai/start.html
![Screen Shot 2020-02-04 at 12 50 57 PM](https://user-images.githubusercontent.com/2532981/73785876-0a5ad400-474d-11ea-911d-899e1b838b26.png)

* MXNet: https://mxnet.apache.org/get_started
![Screen Shot 2020-02-04 at 12 51 40 PM](https://user-images.githubusercontent.com/2532981/73785924-28283900-474d-11ea-87f8-23e22d121a0a.png)

**The idea is to make the installation doc page less overwhelming, by letting the user filter the doc by the use case they have in mind.** The vast majority of users will not want to build XGBoost from the source, so hide the build detail until the user requests it. For example, on the MXNet page, you can select "Build From Source" in the selector in order to display the source build instructions.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.