No instructions on how to create your own workshop

[balupton]

The "create your own lesson" link goes here, but there is no information on how to create your own module, just this repo.

I was expecting something like:

1. Create index.js, that has:

   require('workshopper').create({
     exercisesPath: __dirname+'./exercises,
   })

2. Create your exercises directory.

3. Publish your workshop!

But instead I just get a big wad of code in this repo with no instructions.

[rvagg]

This pains me a lot but I haven't been able to allocate time to properly document and have largely left it up to learnyounode (and now goingnative) to serve as documentation. Good documentation is something I normally value putting time in to!

@linclark posted a great blog post that serves as an even better getting-started, you should refer to it here: http://lin-clark.com/blog/2014/07/01/authoring-nodejs-workshopper-lessons/ and accompanying clonable demo: https://github.com/linclark/demo-workshopper

I'll keep this issue open until I have proper docs done.

[balupton]

@rvagg thanks will check it out

[GarrettS]

Why not use the nodeschool events to help implement workshopper? Just an idea...

[kevinsimper]

I can agree that it is very difficult to figure out how to put a workshopper together.

• Learnyounode is good, but the repository is soo large because of all the translation files.
• @linclark article is good, but in the article he goes directly from 0-100 because he tells how to test a hapi.js server, but .addProcessor part, the code is actually larger than the description on how it works. It should be the reverse.

@rvagg Should the documentation on how to create a workshopper be here or in the workshopper-exercise repository?

[kevinsimper]

In the readme it says that the documentation is being worked on, but that is a long time, and by writing that you don't want to add anything, because it would be potentily be removed, when ever the "new documentation" is released. I propose to remove it, since it does not invite for contributions.