doc: more formatting fixes by ChALkeR · Pull Request #7727 · nodejs/node · GitHub

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

More or less a continuation of #7637.

Fixes some documentation formatting issues, this time split into separate commits (I can squash them, though).

Convert all instances if tab indentation in *.md files to spaces. This affects only three files — archive and 0.10 changelogs and one CTC meeting.
Language specification in the top-level *.md files code blocks.
Change the very top heading style in the README.md to be consistent with all the other headings (no visual change).
Remove extra two spaces indentation which was somewhy present in the iojs changelog for versions from v1.8.1 to v3.3.1 (last). It is not present in other changelogs and was not present before v1.8.1.
Minor fixes in the benchmark dir — specify language for code blocks, move definitions to the bottom.

/cc @nodejs/documentation, @addaleax, @silverwind

@Fishrock123 Ah, previous commit merged with «sh». There is no difference though — you could use the file extension here, as js vs javascript and md vs markdown.

Should I change it?

Yep these are all aliases. I'd prefer we keep it sh for simplicity.

This probably should be console, but I need to re-check the code highlighting on that.

Added fixes for the benchmark dir. /cc @mscdex

Btw, the way it currently renders isn't nice:

crypto: Disable autonegotiation for SSLv2/3 by default (Fedor Indutny,
Timothy J Fontaine, Alexis Campailla)
This is a behavior change, by default we will not allow the negotiation to
SSLv2 or SSLv3. If you want this behavior, run Node.js with either
--enable-ssl2 or --enable-ssl3 respectively.
This does not change the behavior for users specifically requesting
SSLv2_method or SSLv3_method. While this behavior is not advised, it is
assumed you know what you're doing since you're specifically asking to use
these methods.

Perhaps split this into three paragraphs, i.e

crypto: Disable autonegotiation for SSLv2/3 by default (Fedor Indutny,
Timothy J Fontaine, Alexis Campailla)

This is a behavior change, by default we will not allow the negotiation to
SSLv2 or SSLv3. If you want this behavior, run Node.js with either
--enable-ssl2 or --enable-ssl3 respectively.

This does not change the behavior for users specifically requesting
SSLv2_method or SSLv3_method. While this behavior is not advised, it is
assumed you know what you're doing since you're specifically asking to use
these methods.

Opinions?

Splitting these into paragraphs sounds like a good idea to me.

I will rebase this once #7971 lands.

Upd: On a second thought, I will just exclude Readme changes =).

Rebased. I did not include the sh→console changes in the docs dir, those should not be blocking this and could be filed in another PR.

Dropped the Readme changes in favour of #7971, which covers more issues.

/cc @Trott, @nodejs/documentation

LGTM

* Add language specification for the txt code blocks. * Move the definitions to the bottom. Ref: #7727

LGTM

Convert all instances of tab indentation in *.md files to spaces. This affects only three files. PR-URL: nodejs#7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Continuing what a58b48b did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by nodejs#7971 Refs: nodejs#7637 PR-URL: nodejs#7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

This removes the extra two spaces indentation which was somewhy present in the iojs changelog from v1.8.1 to v3.3.1. iojs changelog was the only file affected. PR-URL: nodejs#7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

* Add language specification for the txt code blocks. * Move the definitions to the bottom. Ref: nodejs#7727 PR-URL: nodejs#7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

This splits one huge commit description into paragraphs, which supposedly was the intended behavior there. PR-URL: nodejs#7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Landed in 7400a4a...e1643cc.

Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: nodejs#7637 Refs: nodejs#7727 Refs: nodejs#7757 PR-URL: nodejs#7729 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

@ChALkeR could you backport commit f3f5a89 only. It doesn't apply cleanly, and it appears that the benchmarking README has gotten pretty out of sync with the one in master.

Convert all instances of tab indentation in *.md files to spaces. This affects only three files. PR-URL: #7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Continuing what a58b48b did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by #7971 Refs: #7637 PR-URL: #7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

This removes the extra two spaces indentation which was somewhy present in the iojs changelog from v1.8.1 to v3.3.1. iojs changelog was the only file affected. PR-URL: #7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

This splits one huge commit description into paragraphs, which supposedly was the intended behavior there. PR-URL: #7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

does not backport cleanly

Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

ChALkeR added the doc Issues and PRs related to the documentations. label Jul 14, 2016

ChALkeR changed the title More doc fixes doc: more formatting fixes Jul 14, 2016

Fishrock123 reviewed Jul 14, 2016
View reviewed changes

ChALkeR mentioned this pull request Jul 14, 2016

tools: add remark-lint configuration in .remarkrc #7729

Merged

1 task

ChALkeR reviewed Jul 14, 2016
View reviewed changes

ChALkeR mentioned this pull request Jul 15, 2016

doc: various documentation formatting fixes #7637

Merged

2 tasks

ChALkeR force-pushed the more-doc-fixes branch from 2212259 to a43c306 Compare August 4, 2016 03:19

ChALkeR added a commit that referenced this pull request Aug 4, 2016

doc: *.md formatting fixes in the benchmark dir

2ba0f55

* Add language specification for the txt code blocks. * Move the definitions to the bottom. Ref: #7727

ChALkeR added 5 commits August 4, 2016 11:09

doc: convert tabs to spaces

9ddc915

Convert all instances of tab indentation in *.md files to spaces. This affects only three files. PR-URL: nodejs#7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

ChALkeR force-pushed the more-doc-fixes branch from a43c306 to e1643cc Compare August 4, 2016 08:15

ChALkeR merged commit e1643cc into nodejs:master Aug 4, 2016

ChALkeR mentioned this pull request Aug 5, 2016

doc: use git-secure-tag for release tags #7603

Closed

4 tasks

cjihrig mentioned this pull request Aug 8, 2016

v6.4.0 Release Proposal #8020

Closed

cjihrig mentioned this pull request Aug 11, 2016

v6.4.0 Proposal #8070

Merged

Fishrock123 added the dont-land-on-v6.x label Sep 6, 2016

MylesBorins added the dont-land-on-v4.x label Sep 9, 2016

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

doc: more formatting fixes by ChALkeR · Pull Request #7727 · nodejs/node · GitHub

Uh oh!

Uh oh!

doc: more formatting fixes - #7727

doc: more formatting fixes#7727ChALkeR merged 5 commits intonodejs:masternodejs/node:masterfrom ChALkeR:more-doc-fixesChALkeR/io.js:more-doc-fixesCopy head branch name to clipboard

Conversation

ChALkeR commented Jul 14, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Description of change

Uh oh!

Fishrock123 Jul 14, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Fishrock123 Jul 14, 2016

Choose a reason for hiding this comment

Uh oh!

ChALkeR Jul 14, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind Jul 14, 2016

Choose a reason for hiding this comment

Uh oh!

ChALkeR Jul 18, 2016

Choose a reason for hiding this comment

Uh oh!

ChALkeR commented Jul 14, 2016

Uh oh!

ChALkeR Jul 14, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

addaleax Jul 26, 2016

Choose a reason for hiding this comment

Uh oh!

ChALkeR commented Aug 4, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChALkeR commented Aug 4, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Trott commented Aug 4, 2016

Uh oh!

targos commented Aug 4, 2016

Uh oh!

jasnell commented Aug 4, 2016

Uh oh!

ChALkeR commented Aug 4, 2016

Uh oh!

cjihrig commented Aug 10, 2016

Uh oh!

Fishrock123 commented Sep 6, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

doc: more formatting fixes#7727
ChALkeR merged 5 commits into
nodejs:masterfrom
ChALkeR:more-doc-fixes

ChALkeR commented Jul 14, 2016 •
edited
Loading

Fishrock123 Jul 14, 2016 •
edited
Loading

ChALkeR Jul 14, 2016 •
edited
Loading

ChALkeR Jul 14, 2016 •
edited
Loading

ChALkeR commented Aug 4, 2016 •
edited
Loading

ChALkeR commented Aug 4, 2016 •
edited
Loading