Skip to content

Add meta doc summarizing dependencies - #217

Merged
fhemberger merged 1 commit into
nodejs:masterfrom
Qard:docs-meta-dependencies
Oct 23, 2015
Merged

Add meta doc summarizing dependencies#217
fhemberger merged 1 commit into
nodejs:masterfrom
Qard:docs-meta-dependencies

Conversation

@Qard

@QardQard commented Oct 7, 2015

Copy link
Copy Markdown
Member

Note: This is part of the migration of content files from https://github.com/nodejs/docs, see: nodejs/docs#44

This doc explains the high-level purpose of the various dependencies and provides links to documentation for each.

This doc explains the high-level purpose of the various dependencies
and provides links to documentation for each.
@Qard

Qard commented Oct 9, 2015

Copy link
Copy Markdown
MemberAuthor

@nodejs/documentation @nodejs/website Can I get a LGTM, just for good measure? :)

@fhembergerfhemberger added the content Issues/pr concerning content label Oct 9, 2015
@phillipj

Copy link
Copy Markdown
Member

Should it be linked to from the docs section right away?

@fhemberger

Copy link
Copy Markdown
Contributor

Now we have PRs for adding pages as docs, meta docs, guides, topics and knowledge base. This is confusing for the users (at least it is for me now). I think having less categories (and/or a clearer structure) would be a better approach.

Otherwise LGTM.

@Qard

Qard commented Oct 16, 2015

Copy link
Copy Markdown
MemberAuthor

The intent is for there to be separate sections for different types of docs: reference, guides, topics and meta (which is about developing node itself). This was what the Docs WG had decided on back at NodeConf. Do you feel differently? We're always open to feedback. 😺

@fhemberger

Copy link
Copy Markdown
Contributor

Sorry, didn't get the Docs WG memo. Is there a doc/issue on this topic you can point me to? It's hard to trace back decisions that were made at a conference. 😉

How is this related to the Knowledge Base discussed in #211? I know this is content originally coming from Nodejitsu, but as a new user coming to the website I would probably have a hard time to decide what the difference between "Knowledge Base", "Guides" and "Topics" is.

@fhembergerfhemberger mentioned this pull request Oct 16, 2015
3 tasks
@Qard

Qard commented Oct 16, 2015

Copy link
Copy Markdown
MemberAuthor

The original idea is mapped out in the trello board linked in nodejs/docs#1.

@Qard

Qard commented Oct 16, 2015

Copy link
Copy Markdown
MemberAuthor

As for the Knowledge Base stuff, that hasn't really been discussed yet, but I agree that it overlaps a lot. I suspect the articles from it might get divided up into our topics and guides sections eventually.

@fhemberger

Copy link
Copy Markdown
Contributor

@Qard Thanks for the link!

@fhemberger

Copy link
Copy Markdown
Contributor

@Qard I'd like to merge this. Can someone please add a link to the website? @bnb offered to take care of this (#254 (comment)).

@bnb

bnb commented Oct 22, 2015

Copy link
Copy Markdown
Contributor

@fhemberger I'll do it. Just add the link in the other issue?

@Qard

Qard commented Oct 22, 2015

Copy link
Copy Markdown
MemberAuthor

It should be fine to just merge this and leave linking to it to another PR.

fhemberger added a commit that referenced this pull request Oct 23, 2015
@fhemberger
fhemberger merged commit f1d795b into nodejs:masterOct 23, 2015
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contentIssues/pr concerning contenton hold

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Qard@phillipj@fhemberger@bnb