Knowledge Base

[mikeal]

This is a migration of the documentation Nodejitsu built over the last 5 years or so. Before we can merge I'll have to finalize the transfer of copyright from Nodejitsu/GoDaddy to the foundation.

This work would provide a nice starting point for a knowledge base we can continue to build and iterate on as a community.

I also removed author information. IMO having the initial author noted for each article is a barrier to others editing and maintaining those pages.

Things still to do:

• Improve the template so that it suggests other content.
• Create a directory page that shows all content.
• Find a good way to expose and link to this content from the main docs page.

/cc @indexzero @nodejs/documentation

[indexzero]

+1 here on the Copyright transfer. We'll work to get that sorted with legal folks so it can transfer from Nodejitsu to the foundation.

What are thoughts on putting this in a separate repo and including it as a module?

[mikeal]

@indexzero this repo is already setup for auto-deploy and has a localization system attached, and will soon have localizers and doc writers as write access members. It's going to get pretty complicated to do an additional repo with all of that. Not to mention this repo has contributors already making style improvements and whatnot. This is the path of least resistance for sure.

[Qard]

Great stuff! This'll really help to seed the Docs WG content. I'd be happy to help out with that todo list. 😄

[mikeal]

@Qard go ahead and send pull requests to the knowledge-base branch to help out :)

[indexzero]

@mikeal 10-4. We'll follow-up offline about the next steps w.r.t. copyright transfer. I assume this will be a topic at the November 2nd board meeting?

[fhemberger]

Please also check how this content relates to #217, #218. It's a bit confusing at the moment.

[fhemberger]

@mikeal @indexzero Is there any progress on this? Would love to hand this over to @nodejs/documentation.

[indexzero]

@fhemberger agreed. Nodejitsu would love to hand this over to @nodejs/documentation as well! I believe the next step here was for this to be discussed during the last foundation legal WG call. I do not sit on the legal committee, but I know @mikeal is aware of the minutes. Hopefully he can give status.

Due an unavoidable work conflict at GoDaddy next Monday I will have to miss most of the Node.js Foundation board call.

@mikeal if this will be part of the public or private session I will make myself available at the pleasure of the board while it is discussed.

[mikeal]

hey @indexzero I think it would help if you could add an MIT/BSD compatible license to the original work on https://github.com/nodejitsu/docs/

[indexzero]

@mikeal done. It is now MIT. nodejitsu/docs@a4800be

[mikeal]

werd, ok, we can merge this now. we'll work out the details of the copyright transfer later, now that it's permissively licensed we can put it in the tree.

[indexzero]

Resisting the urge to push the "Merge" button so hard at the moment. All sentimental. Holding off for the final ok from @fhemberger: are we good to go here?

[fhemberger]

@indexzero @mikeal Should we merge it without the Handlebars templates, so @nodejs/documentation can integrate the docs into their content structure first?

I want to avoid adding redirects later.

[indexzero]

@fhemberger Nodejitsu plans to redirect all traffic from http://docs.nodejitsu.com to the final pages on the nodejs.org site so we will have to do the redirect dance a little no matter what.

Obviously once is better than twice, we could move this into a "draft" area if one exists where it would not get rendered or served yet. Given how old these tutorials are that's probably the best way to approach this: stage them somewhere and publish them one at a time as they are reviewed for correctness.

[fhemberger]

Our staging area at the moment is called "push it without linking it on the site" ;)

[indexzero]

@fhemberger great. So this can be safely merged then?

[fhemberger]

@indexzero I had to fix a few things:

• the missing 'docs-menu' partial in layouts/docs.hbs and layouts/knowledge-base-index.hbs was breaking the the build.
• I excluded the knowledge base index file from the listing and fixed markdown headlines in two documents
• I removed "Downloads" (linking to Node.js 0.4.1 ;)) and 'Hosting, Conferences and More!' (we have a event listing already and some links were broken). I hope that's ok for you.

[fhemberger]

Merged via d02b8a2.

[indexzero]

\o/