Skip to content

doc: fix certificate display in tls doc - #35032

Merged
Trott merged 1 commit into
nodejs:masterfrom
Trott:buffer-tls
Sep 5, 2020
Merged

doc: fix certificate display in tls doc#35032
Trott merged 1 commit into
nodejs:masterfrom
Trott:buffer-tls

Conversation

@Trott

@TrottTrott commented Sep 3, 2020

Copy link
Copy Markdown
Member

In one context, <Buffer> was being interpretted as an HTML tag and not
displayed.

Checklist

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem. labels Sep 3, 2020
@Trott

This comment has been minimized.

@richardlau

Copy link
Copy Markdown
Member

Unfortunately this regresses the markdown view:
Before:
image

After:
image

I suppose on balance most readers will be reading the HTML docs.

@Trott

Trott commented Sep 3, 2020

Copy link
Copy Markdown
MemberAuthor

I suppose on balance most readers will be reading the HTML docs.

My sense has always been that markdown is an authoring format for us but HTML is our publishing format. So, for example, we have many broken links in the markdown, but they work just fine in the HTML.

Although something that displayed correctly in both places would be great.

@Trott

Trott commented Sep 3, 2020

Copy link
Copy Markdown
MemberAuthor

Changing the language string from txt to js (which would seem to be semantically correct) fixes this too and doesn't break the markdown file. I've updated the PR. @richardlau PTAL

image

@Trott

Trott commented Sep 5, 2020

Copy link
Copy Markdown
MemberAuthor

@nodejs/website

In one context, `<Buffer>` was being interpretted as an HTML tag and not
displayed.
PR-URL: nodejs#35032
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@Trott
Trott merged commit a05f672 into nodejs:masterSep 5, 2020
@Trott

Trott commented Sep 5, 2020

Copy link
Copy Markdown
MemberAuthor

Landed in a05f672

@Trott
Trott deleted the buffer-tls branch September 5, 2020 16:49
richardlau pushed a commit that referenced this pull request Sep 7, 2020
In one context, `<Buffer>` was being interpretted as an HTML tag and not
displayed.
PR-URL: #35032
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@richardlaurichardlau mentioned this pull request Sep 7, 2020
4 tasks
richardlau pushed a commit that referenced this pull request Sep 7, 2020
In one context, `<Buffer>` was being interpretted as an HTML tag and not
displayed.
PR-URL: #35032
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
In one context, `<Buffer>` was being interpretted as an HTML tag and not
displayed.
PR-URL: #35032
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
In one context, `<Buffer>` was being interpretted as an HTML tag and not
displayed.
PR-URL: #35032
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@codebyterecodebytere mentioned this pull request Sep 28, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
In one context, `<Buffer>` was being interpretted as an HTML tag and not
displayed.
PR-URL: nodejs#35032
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.tlsIssues and PRs related to the tls subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Trott@richardlau@addaleax@nschonni@MrHeer@nodejs-github-bot