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.

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

Reorganize the installation documents. #6877

Merged
merged 8 commits into from
Apr 21, 2021

Conversation

trivialfis
Copy link
Member

@trivialfis trivialfis commented Apr 20, 2021

  • Split up installation and building from source.
  • Use consistent section titles.
  • Documents from jvm package are gathered into the installation guide and building from source guide.

The installation doc is split into 2 sections, one for stable release another for the nightly build. Each section contains subsections for Python, R, and JVM.

Also building from source code is now an independent page detailing the instructions for each package.

It's nowhere close to what #5282 is describing, but I think at least it cleanups the current document a little bit.

Here are the TOCs for installation and build:

  • Install
    install

  • Build
    build

* Split up installation and building from source.
* Use consistent section titles.

The installation doc is split into 2 sections, one for stable release another for nightly
build.  Each section contains subsections for Python, R and JVM.

Also building from source code is now an independent page detailing the instructions for
each package.
@trivialfis trivialfis requested review from hcho3 and RAMitchell April 20, 2021 18:50
Copy link
Collaborator

@hcho3 hcho3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done! I like how the new installation doc is organized. I have some minor comments.

doc/build.rst Show resolved Hide resolved
doc/build.rst Outdated Show resolved Hide resolved
doc/build.rst Outdated Show resolved Hide resolved
doc/build.rst Outdated Show resolved Hide resolved
doc/build.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
doc/install.rst Outdated Show resolved Hide resolved
Co-authored-by: Philip Hyunsu Cho <chohyu01@cs.washington.edu>
@trivialfis
Copy link
Member Author

Thanks for the suggestions, all applied.

doc/build.rst Outdated Show resolved Hide resolved
doc/build.rst Outdated Show resolved Hide resolved
trivialfis and others added 2 commits April 22, 2021 02:45
Co-authored-by: Philip Hyunsu Cho <chohyu01@cs.washington.edu>
Co-authored-by: Philip Hyunsu Cho <chohyu01@cs.washington.edu>
@trivialfis trivialfis merged commit 896aede into dmlc:master Apr 21, 2021
@trivialfis trivialfis deleted the installation-doc branch April 21, 2021 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants