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

Jump to bottom

doc: spruce up user journey to local docs browsing #34986

Closed
wants to merge 5 commits into from
Closed

doc: spruce up user journey to local docs browsing #34986

wants to merge 5 commits into from

Conversation

DerekNonGeneric
Copy link
Contributor

@DerekNonGeneric DerekNonGeneric commented Aug 30, 2020 •
edited

This patch improves the means by which the docs are viewed locally.

  • Remove extraneous code in the docserve Makefile target
  • Document the docserve task for all to know
  • Bring all code snippets in this section up to speed
  • Clarify the purpose of each documentation browsing method

Fixes: #34977

@nodejs-github-bot nodejs-github-bot added build doc labels Aug 30, 2020
DerekNonGeneric
DerekNonGeneric reviewed Aug 30, 2020
View changes
BUILDING.md Outdated Show resolved Hide resolved
DerekNonGeneric
DerekNonGeneric reviewed Aug 30, 2020
View changes
BUILDING.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Aug 30, 2020
View changes
BUILDING.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Aug 30, 2020
View changes
Makefile Outdated Show resolved Hide resolved
@DerekNonGeneric
doc: spruce up user journey to local docs browsing
94b75aa 
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

Fixes: nodejs#34977
@DerekNonGeneric
Copy link
Contributor Author

@DerekNonGeneric DerekNonGeneric commented Aug 30, 2020 •
edited

Welp, not much of a diff anymore in light of #34977 (comment), but this does indeed work on my machine for some reason and speculate that it's due to having run ./configure beforehand, which was able to identify my correct Python version.

@richardlau
Copy link
Member

@richardlau richardlau commented Aug 30, 2020

configure will write the detected Python into config.mk, which is included in the Makefile

node/Makefile

Line 1 in e1edd6b

-include config.mk

aduh95
aduh95 reviewed Aug 30, 2020
View changes
Makefile Show resolved Hide resolved
aduh95
aduh95 reviewed Aug 30, 2020
View changes
BUILDING.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

@codecov-commenter codecov-commenter commented Aug 31, 2020

Codecov Report

Merging #34986 into master will increase coverage by 0.01%.
The diff coverage is 89.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #34986      +/-   ##
==========================================
+ Coverage   96.67%   96.69%   +0.01%     
==========================================
  Files         208      207       -1     
  Lines       68993    69126     +133     
==========================================
+ Hits        66701    66841     +140     
+ Misses       2292     2285       -7
Impacted Files Coverage Δ
lib/internal/errors.js 97.97% <50.00%> (+0.13%) ⬆️
lib/internal/modules/esm/resolve.js 94.53% <80.00%> (+<0.01%) ⬆️
lib/internal/policy/manifest.js 86.53% <87.66%> (+8.13%) ⬆️
lib/internal/modules/cjs/loader.js 94.71% <90.90%> (+<0.01%) ⬆️
lib/perf_hooks.js 96.00% <94.11%> (+0.04%) ⬆️
lib/_stream_readable.js 99.01% <100.00%> (+<0.01%) ⬆️
lib/internal/modules/esm/get_source.js 90.47% <100.00%> (+5.11%) ⬆️
lib/internal/modules/package_json_reader.js 100.00% <100.00%> (ø)
lib/internal/process/execution.js 98.09% <100.00%> (-0.07%) ⬇️
lib/net.js 95.29% <100.00%> (-0.01%) ⬇️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a1faa8d...94b75aa. Read the comment docs.

@mmarchini

This comment has been minimized.

Sign in to view
@DerekNonGeneric
Copy link
Contributor Author

@DerekNonGeneric DerekNonGeneric commented Aug 31, 2020

@mmarchini, I've clarified the prose a bit, PTAL.

aduh95
aduh95 reviewed Aug 31, 2020
View changes
BUILDING.md Show resolved Hide resolved
aduh95
aduh95 reviewed Aug 31, 2020
View changes
BUILDING.md Show resolved Hide resolved
@DerekNonGeneric DerekNonGeneric added the author ready label Sep 1, 2020
DerekNonGeneric
DerekNonGeneric reviewed Sep 4, 2020
View changes
Makefile Outdated Show resolved Hide resolved
@DerekNonGeneric
Copy link
Contributor Author

@DerekNonGeneric DerekNonGeneric commented Sep 4, 2020

There's still some sort of a bug here. It's not working as I would expect. I should be able to run:

make docclean
make docserve

However, instead, I get this error:

Error: ENOENT: no such file or directory, open 'out/doc/apilinks.json'
    at Object.openSync (fs.js:457:3)
    at Object.writeFileSync (fs.js:1282:35)
    at Object.<anonymous> (/mnt/c/orgs/nodejs/node-runtime/tools/doc/apilinks.js:211:4)
    at Module._compile (internal/modules/cjs/loader.js:1157:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1177:10)
    at Module.load (internal/modules/cjs/loader.js:1001:32)
    at Function.Module._load (internal/modules/cjs/loader.js:900:14)
    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:74:12)
    at internal/main/run_main_module.js:18:47 {
  errno: -2,
  syscall: 'open',
  code: 'ENOENT',
  path: 'out/doc/apilinks.json'
}

This is evidence that #34986 (comment) needs to be addressed first.

@DerekNonGeneric DerekNonGeneric removed the author ready label Sep 4, 2020
@aduh95 aduh95 mentioned this pull request Sep 4, 2020
Closed
2 tasks
@DerekNonGeneric @aduh95
Update Makefile
515b05f 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@DerekNonGeneric DerekNonGeneric added the author ready label Sep 4, 2020
DerekNonGeneric added a commit that referenced this issue Sep 6, 2020
doc: spruce up user journey to local docs browsing
ff0aad0 
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

Fixes: #34977

PR-URL: #34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@DerekNonGeneric
Copy link
Contributor Author

@DerekNonGeneric DerekNonGeneric commented Sep 6, 2020

Landed in ff0aad0

richardlau pushed a commit that referenced this issue Sep 7, 2020
@richardlau
doc: spruce up user journey to local docs browsing
c9c2f2c 
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

Fixes: #34977

PR-URL: #34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@richardlau richardlau mentioned this pull request Sep 7, 2020
Merged
4 tasks
richardlau pushed a commit that referenced this issue Sep 7, 2020
@richardlau
doc: spruce up user journey to local docs browsing
a08e853 
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

Fixes: #34977

PR-URL: #34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
addaleax pushed a commit that referenced this issue Sep 22, 2020
@addaleax
doc: spruce up user journey to local docs browsing
abddf78 
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

Fixes: #34977

PR-URL: #34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
addaleax pushed a commit that referenced this issue Sep 22, 2020
@addaleax
doc: spruce up user journey to local docs browsing
fb1a133 
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

Fixes: #34977

PR-URL: #34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@codebytere codebytere mentioned this pull request Sep 28, 2020
Merged
joesepi pushed a commit to joesepi/node that referenced this issue Jan 8, 2021
@DerekNonGeneric @joesepi
doc: spruce up user journey to local docs browsing
67c0596 
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

Fixes: nodejs#34977

PR-URL: nodejs#34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott

@aduh95 aduh95

@richardlau richardlau

@mmarchini mmarchini

Assignees
No one assigned
Labels
author ready build doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

tools: the docserve make target doesn't seem to finally serve
7 participants
@DerekNonGeneric @richardlau @codecov-commenter @mmarchini @Trott @aduh95 @nodejs-github-bot