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

BUILDING.md: how-to-install has become obscured #25458

Closed
tshinnic opened this issue Jan 11, 2019 · 2 comments
Closed

BUILDING.md: how-to-install has become obscured #25458

tshinnic opened this issue Jan 11, 2019 · 2 comments
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. help wanted Issues that need assistance from volunteers or PRs that need help to proceed. install Issues and PRs related to the installers.

Comments

@tshinnic
Copy link
Contributor

The procedure to build and then install node has become obscured through changes
to BUILDING.md over the last two years. Much additional information has been added for
running tests, coverage, build docs, etc. and now important steps such as

$ [sudo] make install

are 4 pages down from the starting $ ./configure step, and is tacked on the end of
"Building the documentation"! How is someone unfamiliar with the "usual steps"
supposed to find "how to install node" ?

Simplest fix would be to emulate all the new section headings and add an "Installing
Node" section header before the four lines beginning "To test if Node.js was built
correctly:" I somehow feel the new section should be before subjects docs, coverage,
and maybe before even tests, given how much those have been elaborated on.

[doc]

@vsemozhetbyt vsemozhetbyt added doc Issues and PRs related to the documentations. build Issues and PRs related to build files or the CI. install Issues and PRs related to the installers. labels Jan 12, 2019
@mhdawson
Copy link
Member

I tend to agree. Do @tshinnic do you want to file a PR. I think it might make sense to add the "Installing Node" section right after the "Building Node.js" section with a comment that if all you want to do after building is to use Node.js then these are the install steps. If you want to test etc. then the following paragraphs will help you with that.

@jasnell jasnell added the help wanted Issues that need assistance from volunteers or PRs that need help to proceed. label Jun 26, 2020
@PoojaDurgad
Copy link
Contributor

fixed!!! #35710

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. help wanted Issues that need assistance from volunteers or PRs that need help to proceed. install Issues and PRs related to the installers.
Projects
None yet
Development

No branches or pull requests

5 participants