-
-
Notifications
You must be signed in to change notification settings - Fork 37.1k
BUILDING.md: how-to-install has become obscured #25458
Copy link
Copy link
Closed
Labels
buildIssues and PRs related to Node.js builds or CI infrastructure.Issues and PRs related to Node.js builds or CI infrastructure.docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.help wantedIssues that need assistance from volunteers or PRs that need help to proceed.Issues that need assistance from volunteers or PRs that need help to proceed.installIssues and PRs related to installing Node.js and its installers.Issues and PRs related to installing Node.js and its installers.
Description
Activity
Metadata
Metadata
Assignees
Labels
buildIssues and PRs related to Node.js builds or CI infrastructure.Issues and PRs related to Node.js builds or CI infrastructure.docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.help wantedIssues that need assistance from volunteers or PRs that need help to proceed.Issues that need assistance from volunteers or PRs that need help to proceed.installIssues and PRs related to installing Node.js and its installers.Issues and PRs related to installing Node.js and its installers.
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
are 4 pages down from the starting
$ ./configurestep, 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]