Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix certificate display in tls doc #35032

Merged
merged 1 commit into from
Sep 5, 2020
Merged

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 3, 2020

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

Checklist

@nodejs-github-bot nodejs-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
Member

Unfortunately this regresses the markdown view:
Before:
image

After:
image

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

@Trott
Copy link
Member Author

Trott commented Sep 3, 2020

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
Copy link
Member Author

Trott commented Sep 3, 2020

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
Copy link
Member Author

Trott commented Sep 5, 2020

@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:master Sep 5, 2020
@Trott
Copy link
Member Author

Trott commented Sep 5, 2020

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>
@richardlau richardlau 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>
@codebytere codebytere 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 free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants