From 5fdeb16d77d74fd7ea05740dd3b0bfce34d7701e Mon Sep 17 00:00:00 2001 From: Frederic Hemberger Date: Wed, 7 Mar 2018 16:59:26 +0100 Subject: [PATCH] Better structure for guides' overview page So far guides appeared in random order which makes it hard to find your way around. This change groups related guides. Because of that it also disables the prev/next navigation (as order doesn't match any longer). Also fixed some little nits. Ref: https://github.com/nodejs/help/issues/1122 --- layouts/docs.hbs | 2 +- layouts/guides-index.hbs | 28 ------------------- locale/en/docs/guides/index.md | 26 ++++++++++++++++- locale/en/docs/guides/simple-profiling.md | 2 +- locale/ko/docs/guides/index.md | 22 ++++++++++++++- .../guides/anatomy-of-an-http-transaction.md | 3 +- locale/uk/docs/guides/index.md | 7 ++++- locale/uk/docs/guides/simple-profiling.md | 2 +- 8 files changed, 56 insertions(+), 36 deletions(-) delete mode 100644 layouts/guides-index.hbs diff --git a/layouts/docs.hbs b/layouts/docs.hbs index b23d3c061c808..d4f3b3d967ae1 100644 --- a/layouts/docs.hbs +++ b/layouts/docs.hbs @@ -13,7 +13,7 @@
{{{ contents }}} - {{> prev-next-navigation }} + {{!> prev-next-navigation }}
diff --git a/layouts/guides-index.hbs b/layouts/guides-index.hbs deleted file mode 100644 index 6eccbe7480fc3..0000000000000 --- a/layouts/guides-index.hbs +++ /dev/null @@ -1,28 +0,0 @@ - - -{{> html-head }} - - - {{> header }} - -
-
- - {{> navigation key='docs'}} - -
- {{{ contents }}} - -
    - {{#each collections.guides}} -
  • {{ title }}
    • - {{/each}} -
-
- -
-
- - {{> footer }} - - diff --git a/locale/en/docs/guides/index.md b/locale/en/docs/guides/index.md index 9cfd644f15918..ad1a23c772f9a 100644 --- a/locale/en/docs/guides/index.md +++ b/locale/en/docs/guides/index.md @@ -1,6 +1,30 @@ --- title: Guides -layout: guides-index.hbs +layout: docs.hbs --- # Guides + +## General + +- [Getting Started Guide](getting-started-guide/) +- [Debugging - Getting Started](debugging-getting-started/) +- [Easy profiling for Node.js Applications](simple-profiling/) +- [Dockerizing a Node.js web app](nodejs-docker-webapp/) + + +## Node.js core concepts + +- [Overview of Blocking vs Non-Blocking](blocking-vs-non-blocking/) +- [The Node.js Event Loop, Timers, and process.nextTick()](event-loop-timers-and-nexttick/) +- [Don't Block the Event Loop (or the Worker Pool)](dont-block-the-event-loop/) +- [Timers in Node.js](timers-in-node/) + + +## Module related guides + +- [Anatomy of an HTTP Transaction](anatomy-of-an-http-transaction/) +- [Working with Different Filesystems](working-with-different-filesystems/) +- [Backpressuring in Streams](backpressuring-in-streams/) +- [Domain Module Postmortem](domain-postmortem/) +- [How to publish N-API package](publishing-napi-modules/) diff --git a/locale/en/docs/guides/simple-profiling.md b/locale/en/docs/guides/simple-profiling.md index aef97dbb4070f..d86336e298d6f 100644 --- a/locale/en/docs/guides/simple-profiling.md +++ b/locale/en/docs/guides/simple-profiling.md @@ -85,7 +85,7 @@ high latency on requests. We can easily run the app with the built in profiler: NODE_ENV=production node --prof app.js ``` -and put some load on the server using ab (ApacheBench): +and put some load on the server using `ab` (ApacheBench): ``` curl -X GET "http://localhost:8080/newUser?username=matt&password=password" diff --git a/locale/ko/docs/guides/index.md b/locale/ko/docs/guides/index.md index 14054678ab20b..9f99bc5e6cf69 100644 --- a/locale/ko/docs/guides/index.md +++ b/locale/ko/docs/guides/index.md @@ -1,6 +1,26 @@ --- title: 가이드 -layout: guides-index.hbs +layout: docs.hbs --- # 가이드 + +## General + +- [디버깅 - 시작하기](debugging-getting-started/) +- [Node.js 애플리케이션의 간단한 프로파일링](simple-profiling/) +- [Node.js 웹 앱의 도커라이징](nodejs-docker-webapp/) + + +## Node.js core concepts + +- [블록킹과 논블록킹 살펴보기](blocking-vs-non-blocking/) +- [Node.js 이벤트 루프, 타이머, `process.nextTick()`](event-loop-timers-and-nexttick/) +- [Node.js의 Timers](timers-in-node/) + + +## Module related guides + +- [HTTP 트랜잭션 해부](anatomy-of-an-http-transaction/) +- [여러 파일 시스템에서 작업하기](working-with-different-filesystems/) +- [도메인 모듈 포스트모템](domain-postmortem/) diff --git a/locale/uk/docs/guides/anatomy-of-an-http-transaction.md b/locale/uk/docs/guides/anatomy-of-an-http-transaction.md index 34f73249e2d0c..289514b9c5537 100755 --- a/locale/uk/docs/guides/anatomy-of-an-http-transaction.md +++ b/locale/uk/docs/guides/anatomy-of-an-http-transaction.md @@ -247,7 +247,6 @@ all of the data that was sent to us by the user. We'll format that data as JSON using `JSON.stringify`. ```javascript - const http = require('http'); http.createServer((request, response) => { @@ -364,7 +363,7 @@ though, we'd want to inspect the error to figure out what the correct status cod and message would be. As usual with errors, you should consult the [`Error` documentation][]. -On the response, we'll just log the error to `stdout`. +On the response, we'll just log the error to `stderr`. ```javascript const http = require('http'); diff --git a/locale/uk/docs/guides/index.md b/locale/uk/docs/guides/index.md index 5b657e81fa3d9..68498ec32f839 100755 --- a/locale/uk/docs/guides/index.md +++ b/locale/uk/docs/guides/index.md @@ -1,6 +1,11 @@ --- title: Керівництва -layout: guides-index.hbs +layout: docs.hbs --- # Guides + +- [Easy profiling for Node.js Applications](simple-profiling/) +- [Dockerizing a Node.js web app](nodejs-docker-webapp/) +- [Anatomy of an HTTP Transaction](anatomy-of-an-http-transaction/) +- [Working with Different Filesystems](working-with-different-filesystems/) diff --git a/locale/uk/docs/guides/simple-profiling.md b/locale/uk/docs/guides/simple-profiling.md index cfb505083e5ac..d86336e298d6f 100755 --- a/locale/uk/docs/guides/simple-profiling.md +++ b/locale/uk/docs/guides/simple-profiling.md @@ -85,7 +85,7 @@ high latency on requests. We can easily run the app with the built in profiler: NODE_ENV=production node --prof app.js ``` -and put some load on the server using ab: +and put some load on the server using `ab` (ApacheBench): ``` curl -X GET "http://localhost:8080/newUser?username=matt&password=password"