Skip to content

Commit 7151347

Browse files
authored
Better structure for guides' overview page (nodejs#1581)
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: nodejs/help#1122
1 parent f800855 commit 7151347

File tree

8 files changed

+56
-36
lines changed

8 files changed

+56
-36
lines changed

layouts/docs.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<article>
1414
{{{ contents }}}
1515

16-
{{> prev-next-navigation }}
16+
{{!> prev-next-navigation }}
1717
</article>
1818

1919
</div>

layouts/guides-index.hbs

Lines changed: 0 additions & 28 deletions
This file was deleted.

locale/en/docs/guides/index.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
11
---
22
title: Guides
3-
layout: guides-index.hbs
3+
layout: docs.hbs
44
---
55

66
# Guides
7+
8+
## General
9+
10+
- [Getting Started Guide](getting-started-guide/)
11+
- [Debugging - Getting Started](debugging-getting-started/)
12+
- [Easy profiling for Node.js Applications](simple-profiling/)
13+
- [Dockerizing a Node.js web app](nodejs-docker-webapp/)
14+
15+
16+
## Node.js core concepts
17+
18+
- [Overview of Blocking vs Non-Blocking](blocking-vs-non-blocking/)
19+
- [The Node.js Event Loop, Timers, and process.nextTick()](event-loop-timers-and-nexttick/)
20+
- [Don't Block the Event Loop (or the Worker Pool)](dont-block-the-event-loop/)
21+
- [Timers in Node.js](timers-in-node/)
22+
23+
24+
## Module related guides
25+
26+
- [Anatomy of an HTTP Transaction](anatomy-of-an-http-transaction/)
27+
- [Working with Different Filesystems](working-with-different-filesystems/)
28+
- [Backpressuring in Streams](backpressuring-in-streams/)
29+
- [Domain Module Postmortem](domain-postmortem/)
30+
- [How to publish N-API package](publishing-napi-modules/)

locale/en/docs/guides/simple-profiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ high latency on requests. We can easily run the app with the built in profiler:
8585
NODE_ENV=production node --prof app.js
8686
```
8787

88-
and put some load on the server using ab (ApacheBench):
88+
and put some load on the server using `ab` (ApacheBench):
8989

9090
```
9191
curl -X GET "http://localhost:8080/newUser?username=matt&password=password"

locale/ko/docs/guides/index.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
---
22
title: 가이드
3-
layout: guides-index.hbs
3+
layout: docs.hbs
44
---
55

66
# 가이드
7+
8+
## General
9+
10+
- [디버깅 - 시작하기](debugging-getting-started/)
11+
- [Node.js 애플리케이션의 간단한 프로파일링](simple-profiling/)
12+
- [Node.js 웹 앱의 도커라이징](nodejs-docker-webapp/)
13+
14+
15+
## Node.js core concepts
16+
17+
- [블록킹과 논블록킹 살펴보기](blocking-vs-non-blocking/)
18+
- [Node.js 이벤트 루프, 타이머, `process.nextTick()`](event-loop-timers-and-nexttick/)
19+
- [Node.js의 Timers](timers-in-node/)
20+
21+
22+
## Module related guides
23+
24+
- [HTTP 트랜잭션 해부](anatomy-of-an-http-transaction/)
25+
- [여러 파일 시스템에서 작업하기](working-with-different-filesystems/)
26+
- [도메인 모듈 포스트모템](domain-postmortem/)

locale/uk/docs/guides/anatomy-of-an-http-transaction.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,6 @@ all of the data that was sent to us by the user. We'll format that data as JSON
247247
using `JSON.stringify`.
248248

249249
```javascript
250-
251250
const http = require('http');
252251

253252
http.createServer((request, response) => {
@@ -364,7 +363,7 @@ though, we'd want to inspect the error to figure out what the correct status cod
364363
and message would be. As usual with errors, you should consult the
365364
[`Error` documentation][].
366365

367-
On the response, we'll just log the error to `stdout`.
366+
On the response, we'll just log the error to `stderr`.
368367

369368
```javascript
370369
const http = require('http');

locale/uk/docs/guides/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
title: Керівництва
3-
layout: guides-index.hbs
3+
layout: docs.hbs
44
---
55

66
# Guides
7+
8+
- [Easy profiling for Node.js Applications](simple-profiling/)
9+
- [Dockerizing a Node.js web app](nodejs-docker-webapp/)
10+
- [Anatomy of an HTTP Transaction](anatomy-of-an-http-transaction/)
11+
- [Working with Different Filesystems](working-with-different-filesystems/)

locale/uk/docs/guides/simple-profiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ high latency on requests. We can easily run the app with the built in profiler:
8585
NODE_ENV=production node --prof app.js
8686
```
8787

88-
and put some load on the server using ab:
88+
and put some load on the server using `ab` (ApacheBench):
8989

9090
```
9191
curl -X GET "http://localhost:8080/newUser?username=matt&password=password"

0 commit comments

Comments
 (0)