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: more formatting fixes #7727

Merged
merged 5 commits into from Aug 4, 2016

Conversation

Projects
None yet
9 participants
@ChALkeR
Member

ChALkeR commented Jul 14, 2016

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

@ChALkeR ChALkeR added the doc label Jul 14, 2016

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

@Fishrock123

View changes

BUILDING.md Outdated
@@ -28,7 +28,7 @@ On FreeBSD and OpenBSD, you may also need:
* libexecinfo (FreeBSD and OpenBSD only)
```text
```sh

This comment has been minimized.

@Fishrock123

Fishrock123 Jul 14, 2016

Member

This comment has been minimized.

@Fishrock123

This comment has been minimized.

@ChALkeR

ChALkeR Jul 14, 2016

Member

@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?

This comment has been minimized.

@silverwind

silverwind Jul 14, 2016

Contributor

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

This comment has been minimized.

@ChALkeR

ChALkeR Jul 18, 2016

Member

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

@ChALkeR

This comment has been minimized.

Member

ChALkeR commented Jul 14, 2016

Added fixes for the benchmark dir. /cc @mscdex

@ChALkeR ChALkeR referenced this pull request Jul 14, 2016

Merged

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

1 of 1 task complete
@ChALkeR

View changes

doc/changelogs/CHANGELOG_V010.md Outdated
assumed you know what you're doing since you're specifically asking to use
these methods.
Timothy J Fontaine, Alexis Campailla)
This is a behavior change, by default we will not allow the negotiation to

This comment has been minimized.

@ChALkeR

ChALkeR Jul 14, 2016

Member

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?

This comment has been minimized.

@addaleax

addaleax Jul 26, 2016

Member

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

@ChALkeR ChALkeR referenced this pull request Jul 15, 2016

Merged

doc: various documentation formatting fixes #7637

2 of 2 tasks complete
@ChALkeR

This comment has been minimized.

Member

ChALkeR commented Aug 4, 2016

I will rebase this once #7971 lands.

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

@ChALkeR ChALkeR force-pushed the ChALkeR:more-doc-fixes branch Aug 4, 2016

@ChALkeR

This comment has been minimized.

Member

ChALkeR commented Aug 4, 2016

Rebased. I did not include the shconsole 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

@Trott

This comment has been minimized.

Member

Trott commented Aug 4, 2016

LGTM

1 similar comment
@targos

This comment has been minimized.

Member

targos commented Aug 4, 2016

LGTM

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

doc: *.md formatting fixes in the benchmark dir
* Add language specification for the txt code blocks.
* Move the definitions to the bottom.

Ref: #7727
@jasnell

This comment has been minimized.

Member

jasnell commented Aug 4, 2016

LGTM

ChALkeR added some commits Jul 14, 2016

doc: convert tabs to spaces
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>
doc: *.md formatting fixes in the top-level dir
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>
doc: remove extra indentation in iojs changelog
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>
doc: *.md formatting fixes in the benchmark dir
* Add language specification for the txt code blocks.
* Move the definitions to the bottom.

Ref: #7727

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>
doc: fix minor formatting issue in 0.10 changelog
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>

@ChALkeR ChALkeR force-pushed the ChALkeR:more-doc-fixes branch to e1643cc Aug 4, 2016

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

@ChALkeR

This comment has been minimized.

Member

ChALkeR commented Aug 4, 2016

Landed in 7400a4a...e1643cc.

@ChALkeR ChALkeR referenced this pull request Aug 5, 2016

Closed

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

4 of 4 tasks complete

ChALkeR added a commit to ChALkeR/io.js that referenced this pull request Aug 7, 2016

tools: add remark-lint configuration in .remarkrc
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>

@cjihrig cjihrig referenced this pull request Aug 8, 2016

Closed

v6.4.0 Release Proposal #8020

@cjihrig

This comment has been minimized.

Contributor

cjihrig commented Aug 10, 2016

@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.

cjihrig added a commit that referenced this pull request Aug 10, 2016

doc: convert tabs to spaces
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>

cjihrig added a commit that referenced this pull request Aug 10, 2016

doc: *.md formatting fixes in the top-level dir
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>

cjihrig added a commit that referenced this pull request Aug 10, 2016

doc: remove extra indentation in iojs changelog
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>

cjihrig added a commit that referenced this pull request Aug 10, 2016

doc: fix minor formatting issue in 0.10 changelog
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>

cjihrig added a commit that referenced this pull request Aug 10, 2016

tools: add remark-lint configuration in .remarkrc
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>

@cjihrig cjihrig referenced this pull request Aug 11, 2016

Merged

v6.4.0 Proposal #8070

@Fishrock123

This comment has been minimized.

Member

Fishrock123 commented Sep 6, 2016

does not backport cleanly

MylesBorins added a commit that referenced this pull request Sep 9, 2016

tools: add remark-lint configuration in .remarkrc
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>

MylesBorins added a commit that referenced this pull request Sep 28, 2016

tools: add remark-lint configuration in .remarkrc
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>

rvagg added a commit that referenced this pull request Oct 18, 2016

tools: add remark-lint configuration in .remarkrc
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>

MylesBorins added a commit that referenced this pull request Oct 26, 2016

tools: add remark-lint configuration in .remarkrc
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>

@gibfahn gibfahn referenced this pull request Jun 15, 2017

Closed

Auditing for 6.11.1 #230

2 of 3 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment