Samples not language aware

[wetndusty]

in many cases changing "Hello, World!" to "Привет, мир!" lead to encoding hell

i guess it not good for newcomers :(

here http2 sample

==========================

const http2 = require('http2');
const fs = require('fs');

const server = http2.createSecureServer({
  key: fs.readFileSync('localhost-privkey.pem'),
  cert: fs.readFileSync('localhost-cert.pem')
});
server.on('error', (err) => console.error(err));

server.on('stream', (stream, headers) => {
  // stream is a Duplex
  stream.respond({
    'content-type': 'text/html',
    ':status': 200
  });
  stream.end('<h1>Hello World (Привет, мир!)</h1>');
});

server.listen(8443);

==================

and how it look in browser -> Hello World (Привет, мир!)

:(

[XhmikosR]

It depends on your editor and its settings. If the file is saved as UTF-8, you shouldn't have such problems.

But I agree, this is too much.

[wetndusty]

my file saved as UTF-8

[XhmikosR]

Wrap your sample code above in code blocks so that it's properly formatted. I cannot try unformatted code.

[wetndusty]

To generate the certificate and key for this example, run:

openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \
  -keyout localhost-privkey.pem -out localhost-cert.pem

[XhmikosR]

What happens if you use 'content-type': 'text/html; charset=utf-8'?

[wetndusty]

What happens if you use 'content-type': 'text/html; charset=utf-8'?

not work

[XhmikosR]

Maybe there's something else wrong, then.

Let's wait for others to chime in.

[wetndusty]

i recheck 'content-type': 'text/html; charset=utf-8' work as expected :) typo :) was utf8

so i guess sample at page https://nodejs.org/dist/latest-v12.x/docs/api/http2.html under title "Server-side example" should be changed at line with code
'content-type': 'text/html',
with
'content-type': 'text/html; charset=utf-8',

and sample become international friendly :)

[wetndusty]

google search 'content-type': 'text/html' site:nodejs.org should return zero :)

[wetndusty]

i tried search utf8 at site nodejs.org - it return many - maybe it not ok?

[XhmikosR]

The thing is that the translators shouldn't have translated this in the first place, and secondly this should have been caught up in review.

But anyway mistakes happen so we are here to fix them, including yourself :)

I'm not sure what's the best solution. The easiest one would be to fix this specific snippet, but for the long term we probably need to standardize this.

/CC @Trott

[Trott]

@nodejs/i18n Opinions on how best to address this?

[XhmikosR]

@wetndusty where's this snippet exactly on the website?

[wetndusty]

https://nodejs.org/dist/latest-v12.x/docs/api/http2.html

[XhmikosR]

That's in the core @Trott

[XhmikosR]

Maybe move this issue there.

[Trott]

Maybe move this issue there.

I believe only the English docs are in core. I think the translations are down through CrowdIn. @nodejs/i18n

[wetndusty]

believe only the English docs are in core

it still english if you just change 'content-type': 'text/html;' to 'content-type': 'text/html; charset=utf-8'

but if anyone change "Hello, world" to "你好世界" or "Привет, мир!" he or she don`t need to do something else to get working as expected sample

[Trott]

believe only the English docs are in core

it still english if you just change 'content-type': 'text/html;' to 'content-type': 'text/html; charset=utf-8'

but if anyone change "Hello, world" to "你好世界" or "Привет, мир!" he or she don`t need to do something else to get working as expected sample

Oh! I see now. Yeah, if you just want to change the content-type in the sample code, that's great, and can be done with a pull request to the doc/api/http2.md documentation file in https://github.com/nodejs/node.

[lpinca]

This is valid for many examples and not just this one https://nodejs.org/dist/latest-v12.x/docs/api/http2.html#http2_server_side_example. In my opinion we should either use Content-Type: text/html; charset=utf-8 for all of them or none.

To be pedantic the examples work as intended and the problem only happens when changing the original data so this is expected. I mean if you are changing the example you should understand your change and what are the consequences that this entails (also update the value of the Content-Type header in this particular case).

[wetndusty]

it sometime hard for newcomers - change hello world to local language is common practice - so change base code to be newcomers friendly variant is not so bad idea (IMHO)