Skip to content

doc: make the documentation print-friendly - #6748

Closed
sorcamarian wants to merge 1 commit into
nodejs:masterfrom
sorcamarian:master
Closed

doc: make the documentation print-friendly#6748
sorcamarian wants to merge 1 commit into
nodejs:masterfrom
sorcamarian:master

Conversation

@sorcamarian

@sorcamariansorcamarian commented May 13, 2016

Copy link
Copy Markdown
Checklist
  • tests and code linting passes
  • a test and/or benchmark is included
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)
Description of change

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label May 13, 2016
@Qard

Qard commented May 13, 2016

Copy link
Copy Markdown
Member

LGTM, but please add doc: to the start of the commit message.

@sorcamariansorcamarian changed the title Make the documentation print-friendlydoc: Make the documentation print-friendlyMay 13, 2016
@Qard

Qard commented May 13, 2016

Copy link
Copy Markdown
Member

Sorry, I meant the commit itself, not just the PR. You'll need to do a git commit --amend to edit the commit message, then force push the modified commit.

@MylesBorins

Copy link
Copy Markdown
Contributor

/cc @nodejs/website

@sorcamarian

Copy link
Copy Markdown
Author

@Qard I did --ammend, and --force push
Please make a check

image

Comment threaddoc/api_assets/style.css Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: missing newline at the end of file.

@sorcamarian

Copy link
Copy Markdown
Author

@ChALkeR I updated the commit.

Comment threaddoc/api_assets/style.css Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New line still missing here.

@lpinca

Copy link
Copy Markdown
Member

Please edit the commit message while you are at it: Make -> make.

Comment threaddoc/api_assets/style.css Outdated

@ChALkeRChALkeRMay 14, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace

html {

with

html {

as I noted above (one space between html and { instead of two).

@sorcamarian

Copy link
Copy Markdown
Author

White spaces removed.

@sorcamarian

Copy link
Copy Markdown
Author

Has something remained?

@addaleax

Copy link
Copy Markdown
Member

@sorcamarian I think this is good to go. Like @lpinca said in his last comment, the commit message subject should be all-lowercase, but things like this can be taken of when landing the commit.

If you’re asking why this isn’t merged yet, it’s just that it’s customary to wait a bit (72 hours over weekends is a general rule) before merging so that everyone has a chance to look at it.

I’d suggest you additionally use Fixes: https://github.com/nodejs/node/issues/6743 instead of the more info line, because then the issue will be closed automatically when your commit is landed.

Also: You author name in this commit is given as “Marian”. Is that intended or do you prefer to be listed (changelog, git log, AUTHORS file) with some other name? People typically prefer their full name, but ultimately it’s up to you.

@sorcamariansorcamarian changed the title doc: Make the documentation print-friendlydoc: make the documentation print-friendlyMay 16, 2016
@sorcamarian

Copy link
Copy Markdown
Author

@addaleax Thanks for the given explanations.

I'm fine with the current name("Marian").

@MylesBorins

Copy link
Copy Markdown
Contributor

LGTM... minor nits regarding newlines + commit message can be fixed when landing

Would like to hear something from more folks from @nodejs/documentation and @nodejs/website

@MylesBorinsMylesBorins self-assigned this May 16, 2016
@lpinca

lpinca commented May 16, 2016

Copy link
Copy Markdown
Member

All nits seem to be fixed.

@addaleax

Copy link
Copy Markdown
Member

LGTM

@sorcamarian

Copy link
Copy Markdown
Author

Any news?

eljefedelrodeodeljefe pushed a commit that referenced this pull request May 23, 2016
Fixes: #6743
PR-URL: #6748
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@eljefedelrodeodeljefe

Copy link
Copy Markdown
Contributor

Landed in c161849. Thanks!

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Node.js documentation is not print-friendly

9 participants

@sorcamarian@Qard@MylesBorins@lpinca@addaleax@eljefedelrodeodeljefe@ChALkeR@nodejs-github-bot@bl4d32