Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion layouts/docs.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<article>
{{{ contents }}}

{{> prev-next-navigation }}
{{!> prev-next-navigation }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would impact reference doc pages too. We probably shouldn't use this layout for guides and leave this line the way it was.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What reference doc pages are you referring to?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, sorry. I misread. It'd probably be good to be able to keep the continuation feature though. Perhaps we should consider putting the guides in sub-folders and number-prefix them to keep some sort of order?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that as well but decided against it (for now):

  • The order and categories I chose are quite arbitrary, there's no "right" flow
  • This would also change URLs and we'd need to setup redirects

This section will be changed anyway in the relaunch we're currently working on, so it's a temporary fix anyway.

</article>

</div>
Expand Down
28 changes: 0 additions & 28 deletions layouts/guides-index.hbs

This file was deleted.

26 changes: 25 additions & 1 deletion locale/en/docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -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/)
2 changes: 1 addition & 1 deletion locale/en/docs/guides/simple-profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
22 changes: 21 additions & 1 deletion locale/ko/docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
---
title: 가이드
layout: guides-index.hbs
layout: docs.hbs
---

# 가이드

## General
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably best to leave this change up to the localization teams so they can pick language-appropriate titles.

Copy link
Contributor Author

@fhemberger fhemberger Mar 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like this change to land and let the Korean language team create a follow-up PR for the new headlines.

/cc @nodejs/nodejs-ko


- [디버깅 - 시작하기](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/)
3 changes: 1 addition & 2 deletions locale/uk/docs/guides/anatomy-of-an-http-transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) => {
Expand Down Expand Up @@ -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');
Expand Down
7 changes: 6 additions & 1 deletion locale/uk/docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -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/)
2 changes: 1 addition & 1 deletion locale/uk/docs/guides/simple-profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down