FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: spruce up user journey to local docs browsing by DerekNonGeneric · Pull Request #34986 · nodejs/node · GitHub

/ node Public

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

Closed
DerekNonGeneric wants to merge 5 commits into
nodejs:masterfrom
DerekNonGeneric:feat/docserve
ConversationCommits (5)ChecksFiles changed
Closed

doc: spruce up user journey to local docs browsing#34986
DerekNonGeneric wants to merge 5 commits into
nodejs:masterfrom
DerekNonGeneric:feat/docserve

Conversation

DerekNonGeneric commented Aug 30, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

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 added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels Aug 30, 2020
DerekNonGeneric commented Aug 30, 2020
View reviewed changes
Comment thread BUILDING.md Outdated
DerekNonGeneric commented Aug 30, 2020
View reviewed changes
Comment thread BUILDING.md Outdated
Trott reviewed Aug 30, 2020
View reviewed changes
Comment thread BUILDING.md Outdated
Trott reviewed Aug 30, 2020
View reviewed changes
Comment thread Makefile Outdated
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: #34977

DerekNonGeneric commented Aug 30, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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 commented Aug 30, 2020

Copy link
Copy Markdown
Member

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 reviewed Aug 30, 2020
View reviewed changes
Comment thread Makefile
aduh95 reviewed Aug 30, 2020
View reviewed changes
Comment thread BUILDING.md Outdated

codecov-commenter commented Aug 31, 2020

Copy link
Copy Markdown

Codecov Report

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

@@            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.

This comment has been minimized.

Sign in to view

DerekNonGeneric commented Aug 31, 2020

Copy link
Copy Markdown
Contributor Author

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

aduh95 reviewed Aug 31, 2020
View reviewed changes
Comment thread BUILDING.md
aduh95 reviewed Aug 31, 2020
View reviewed changes
Comment thread BUILDING.md
DerekNonGeneric commented Sep 4, 2020
View reviewed changes
Comment thread Makefile Outdated

DerekNonGeneric commented Sep 4, 2020

Copy link
Copy Markdown
Contributor Author

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.

aduh95 mentioned this pull request Sep 4, 2020
Closed
2 tasks
Update Makefile
515b05f 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

DerekNonGeneric commented Sep 6, 2020

Copy link
Copy Markdown
Contributor Author

Landed in ff0aad0

richardlau pushed a commit that referenced this pull request Sep 7, 2020
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 mentioned this pull request Sep 7, 2020
Merged
4 tasks
richardlau pushed a commit that referenced this pull request Sep 7, 2020
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 pull request Sep 22, 2020
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 pull request Sep 22, 2020
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 mentioned this pull request Sep 28, 2020
Merged
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Trott Trott left review comments
aduh95 aduh95 left review comments
richardlau richardlau approved these changes
mmarchini Awaiting requested review from mmarchini

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations.

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

Back | FazBrowse Home | New Git URL