From 2d8e7de4622459cd1c1d8d55c7a851908b273c43 Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 19:51:54 +0530 Subject: [PATCH 1/7] doc: Added python SimpleHTTPServer as a method reading docs in browser Documented an easier way for users to browse documentation without setting up a whole web environment. It make the process of reading the latest documentation, and comparing it with the documentation of older versions on the Node.JS website a lot easier. --- BUILDING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 697d4bd63aa107..4c88b4f67eb23c 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -206,6 +206,16 @@ To read the documentation: $ man doc/node.1 ``` +If you prefer to read the documentation in the browser and have `python` +installed, you can run: + +```console +$ cd out/doc/api/ +$ python -m SimpleHTTPServer +``` + +and navigate to `http://localhost:8000` in your browser. + To test if Node.js was built correctly: ```console From ecb58d0527d1bcab4c0b03d8d03e8efd74449669 Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 20:42:40 +0530 Subject: [PATCH 2/7] doc: document `make doconly` Documented `make doconly` as a way to read documentation in the browser. --- BUILDING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 4c88b4f67eb23c..8bc23124952361 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -206,15 +206,14 @@ To read the documentation: $ man doc/node.1 ``` -If you prefer to read the documentation in the browser and have `python` -installed, you can run: +If you prefer to read the documentation in the browser, +run the following once `make doc` is done: ```console -$ cd out/doc/api/ -$ python -m SimpleHTTPServer +$ make doconly ``` -and navigate to `http://localhost:8000` in your browser. +This will open up a browser tab/window with the documentation. To test if Node.js was built correctly: From c355442fa2b9e5ec5bc86bba719a3b6e7775a554 Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 22:32:13 +0530 Subject: [PATCH 3/7] doc: fix doconly to docopen PR-URL: https://github.com/nodejs/node/pull/19321 --- BUILDING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BUILDING.md b/BUILDING.md index 8bc23124952361..c3967c1fa5d382 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -210,7 +210,7 @@ If you prefer to read the documentation in the browser, run the following once `make doc` is done: ```console -$ make doconly +$ make docopen ``` This will open up a browser tab/window with the documentation. From 0770c1f6e8d3a0e137dc3d3a5d8d11ffd7e8c74f Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 19:51:54 +0530 Subject: [PATCH 4/7] doc: Added python SimpleHTTPServer as a method reading docs in browser Documented an easier way for users to browse documentation without setting up a whole web environment. It make the process of reading the latest documentation, and comparing it with the documentation of older versions on the Node.JS website a lot easier. --- BUILDING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index c3967c1fa5d382..4c88b4f67eb23c 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -206,14 +206,15 @@ To read the documentation: $ man doc/node.1 ``` -If you prefer to read the documentation in the browser, -run the following once `make doc` is done: +If you prefer to read the documentation in the browser and have `python` +installed, you can run: ```console -$ make docopen +$ cd out/doc/api/ +$ python -m SimpleHTTPServer ``` -This will open up a browser tab/window with the documentation. +and navigate to `http://localhost:8000` in your browser. To test if Node.js was built correctly: From abd7fc0ad9090f06948400ba65d4b80ea85afb7c Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 20:42:40 +0530 Subject: [PATCH 5/7] doc: document `make doconly` Documented `make doconly` as a way to read documentation in the browser. --- BUILDING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 4c88b4f67eb23c..8bc23124952361 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -206,15 +206,14 @@ To read the documentation: $ man doc/node.1 ``` -If you prefer to read the documentation in the browser and have `python` -installed, you can run: +If you prefer to read the documentation in the browser, +run the following once `make doc` is done: ```console -$ cd out/doc/api/ -$ python -m SimpleHTTPServer +$ make doconly ``` -and navigate to `http://localhost:8000` in your browser. +This will open up a browser tab/window with the documentation. To test if Node.js was built correctly: From b971a1efd29ebfff9191509113904af1e43358ec Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 22:32:13 +0530 Subject: [PATCH 6/7] doc: fix doconly to docopen PR-URL: https://github.com/nodejs/node/pull/19321 --- BUILDING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BUILDING.md b/BUILDING.md index 8bc23124952361..c3967c1fa5d382 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -210,7 +210,7 @@ If you prefer to read the documentation in the browser, run the following once `make doc` is done: ```console -$ make doconly +$ make docopen ``` This will open up a browser tab/window with the documentation. From f6a70dcd22095b818f70d269a0763a3e363ffeae Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Thu, 15 Mar 2018 09:32:30 +0530 Subject: [PATCH 7/7] doc: address nits requested by @Trott PR-URL: https://github.com/nodejs/node/pull/19321 --- BUILDING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index c3967c1fa5d382..e3bd7a7e9db3f8 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -206,14 +206,14 @@ To read the documentation: $ man doc/node.1 ``` -If you prefer to read the documentation in the browser, -run the following once `make doc` is done: +If you prefer to read the documentation in a browser, +run the following after `make doc` is finished: ```console $ make docopen ``` -This will open up a browser tab/window with the documentation. +This will open a browser with the documentation. To test if Node.js was built correctly: