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: add guides to (navigational) _toc.md #6522

Closed
wants to merge 1 commit into from
Closed

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

wants to merge 1 commit into from

Conversation

eljefedelrodeodeljefe
Copy link
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.

This effectivetly gives the guides a home for users to naviagte
to the guides from the reference
@eljefedelrodeodeljefe eljefedelrodeodeljefe added wip Issues and PRs that are still a work in progress. doc Issues and PRs related to the documentations. labels May 2, 2016
@@ -0,0 +1,39 @@
# Building Node with Ninja
Copy link
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?

Copy link
Contributor Author

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

Qard commented May 2, 2016

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

jasnell commented Aug 9, 2016

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

@joshgav
Copy link
Contributor

joshgav commented Oct 14, 2016

@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
Copy link
Contributor

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

@joshgav
Copy link
Contributor

joshgav commented Oct 14, 2016

Thanks @Fishrock123.

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

@rvagg rvagg force-pushed the master branch 2 times, most recently from c133999 to 83c7a88 Compare October 18, 2016 17:01
@eljefedelrodeodeljefe
Copy link
Contributor Author

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.

@@ -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).
Copy link
Member

Choose a reason for hiding this comment

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

long line

@joshgav
Copy link
Contributor

joshgav commented Jan 18, 2017

Related: #10792

@jasnell
Copy link
Member

jasnell commented Mar 1, 2017

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

@jasnell jasnell added the stalled Issues and PRs that are stalled. label Mar 1, 2017
@eljefedelrodeodeljefe
Copy link
Contributor Author

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

Ping @eljefedelrodeodeljefe

@BridgeAR
Copy link
Member

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

@BridgeAR BridgeAR closed this Sep 12, 2017
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. stalled Issues and PRs that are stalled. wip Issues and PRs that are still a work in progress.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants