Skip to content

doc: add guides to (navigational) _toc.md - #6522

Closed
eljefedelrodeodeljefe wants to merge 1 commit into
nodejs:masterfrom
eljefedelrodeodeljefe:doc/link-to-guides-toc
Closed

doc: add guides to (navigational) _toc.md#6522
eljefedelrodeodeljefe wants to merge 1 commit into
nodejs:masterfrom
eljefedelrodeodeljefe:doc/link-to-guides-toc

Conversation

@eljefedelrodeodeljefe

@eljefedelrodeodeljefeeljefedelrodeodeljefe commented May 2, 2016

Copy link
Copy Markdown
Contributor

DO NOT MERGE

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)

doc

Description of change

This effectivetly gives the guides a home for users to naviagte
to the guides from the reference.

It's a little early because of #5408, but we would need to have the discussion asap to put the guides somewhere. Also the home of guides needs to have an own toc, structure and index.html.

cc @nodejs/documentation and @jasnell probably has a good opinion on this, if you like.

@eljefedelrodeodeljefe
doc: add guides to (navigational) _toc.md
96a0361
This effectivetly gives the guides a home for users to naviagte
to the guides from the reference
@eljefedelrodeodeljefeeljefedelrodeodeljefe added wip Issues and PRs that are still a work in progress. doc Issues and PRs related to the documentations. labels May 2, 2016
benjamingr
benjamingr reviewed May 2, 2016
View reviewed changes
Comment threaddoc/guides/compilation/building-node-with-ninja.md
@@ -0,0 +1,39 @@
# Building Node with Ninja

@benjamingrbenjamingrMay 2, 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.

Why is this part of this PR?

@eljefedelrodeodeljefeeljefedelrodeodeljefeMay 2, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

git mv the one file that was already there into some sort of file structure

@Qard

Qard commented May 2, 2016

Copy link
Copy Markdown
Member

Might be better to not impose the directory structure part of categorization. I think it's likely things will move in the future, or topics will come up that fit many categories.

@jasnell

jasnell commented Aug 9, 2016

Copy link
Copy Markdown
Member

ping @eljefedelrodeodeljefe ... what's the status on this?

@Fishrock123Fishrock123 mentioned this pull request Sep 28, 2016
Closed
@joshgav

joshgav commented Oct 14, 2016

Copy link
Copy Markdown
Contributor

@eljefedelrodeodeljefe@Fishrock123 do we want the guides to live in the API docs? In that case, we should consider moving these over too: https://github.com/nodejs/nodejs.org/tree/master/locale/en/docs/guides

@Fishrock123

Fishrock123 commented Oct 14, 2016

Copy link
Copy Markdown
Contributor

The guides belong(ed) here but the build steps necessary were never completed.

@joshgav

joshgav commented Oct 14, 2016

Copy link
Copy Markdown
Contributor

Thanks @Fishrock123.

@eljefedelrodeodeljefe - if I can find some time, do you mind if I work on this?

@rvagg
rvaggforce-pushed the master branch 2 times, most recently from c133999 to 83c7a88CompareOctober 18, 2016 17:01
@eljefedelrodeodeljefe

eljefedelrodeodeljefe commented Dec 1, 2016

Copy link
Copy Markdown
ContributorAuthor

Be my guest. If you don't it will be okay too. I should make a broader proposal for getting this in though and will try to force me working on this the coming weekend.

jasnell
jasnell reviewed Dec 5, 2016
View reviewed changes
Comment threaddoc/guides/compilation/building-node-with-ninja.md
@@ -0,0 +1,39 @@
# Building Node with Ninja

The purpose of this guide is to show how to build Node.js using [Ninja][], as doing so can be significantly quicker than using `make`. Please see [Ninja's site][Ninja] for installation instructions (unix only).

@jasnelljasnellDec 5, 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.

long line

@joshgav

joshgav commented Jan 18, 2017

Copy link
Copy Markdown
Contributor

Related: #10792

@jasnell

jasnell commented Mar 1, 2017

Copy link
Copy Markdown
Member

Ping @eljefedelrodeodeljefe ... still want to pursue this?

@jasnelljasnell added the stalled Issues and PRs that are stalled. label Mar 1, 2017
@eljefedelrodeodeljefe

eljefedelrodeodeljefe commented Mar 1, 2017

Copy link
Copy Markdown
ContributorAuthor

Will check (after now having moved the guides) and possibly merge tomorrow, if there are no objections. Sorry for my lack of time @jasnell and thanks for pining

@BridgeAR

BridgeAR commented Aug 27, 2017

Copy link
Copy Markdown
Member

Ping @eljefedelrodeodeljefe

@BridgeAR

BridgeAR commented Sep 12, 2017

Copy link
Copy Markdown
Member

Closing due to a long inactivity. @eljefedelrodeodeljefe please feel free to reopen if you want to follow up on this.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.stalledIssues and PRs that are stalled.wipIssues and PRs that are still a work in progress.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@eljefedelrodeodeljefe@Qard@jasnell@joshgav@Fishrock123@BridgeAR@benjamingr@ChALkeR