[Michael]

Im working on the docs now.

The categories so far are:
* Development
* Modules
* Problems

so far these titles exist:
DEVELOPMENT
* Creating a Module
* Setting up a Development Environment
* Template Functions
* {jrCore_list}
MODULES
* jrTags
* setting up the jrTags Module
* jrFoxyCart
* setting up FoxyCart
* selling a subscription
*jrEmbed
PROBLEMS
* something's wrong, what do i do?

If you have docs that you dying to read, suggest them so I know to make them sooner. All docs will get done eventually.

Thanks.


_________________
Michael Ussher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[b360]

Great News, Im excited to dig in and cant wait!

I like how the documentation has been well explained in previous versions.
I printed out the entire Jamroom 4 documentation and made it in a 3 ring binder for refrence when I was working with that.

Will there be any documentation also explaining the basics to creating a custom skin/theme?

[Michael]

sure. I hope doug does those pages though. I haven't really played with the skins much.


_________________
Michael Ussher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[b360]

If the "Create A Module" or whatever is available I need to look at that even if just for refrence, if I possible. Im coming from a c# and mmo networking environment but its time to look at developing modules and intergration for this community. Ive been learning php and ready to dig in to some coding.

* Template Functions
* {jrCore_list}
* jrTags
* setting up the jrTags Module



Last edited by b360 on 08/11/13 15:07; edited 1 time in total

[SteveX]

b360, I haven't tried it yet, but Paul's Aparna module might be useful to you.

You might also want to check out Pete's Hello world module here:
https://github.com/PMaynard/JR5-Hello-World


_________________
Kulshi Mezian!

"Stranger from another planet, welcome to our hole. Just strap on your guitar and we'll play some rock and roll"

Ultrabubble create things.

[b360]

Many thanks! Ill look in to that now.

[SteveX]

Michael:

sure. I hope doug does those pages though. I haven't really played with the skins much.

I could do with more skin time too.

Does jrDocs have any FAQ functionality? Or any way of ranking/rating popular questions and answers into a jrFaq module? It would be neat if the jamroomnetwork site worked like that.


_________________
Kulshi Mezian!

"Stranger from another planet, welcome to our hole. Just strap on your guitar and we'll play some rock and roll"

Ultrabubble create things.

[Brian]

SteveX:

Michael: sure. I hope doug does those pages though. I haven't really played with the skins much. I could do with more skin time too. Does jrDocs have any FAQ functionality? Or any way of ranking/rating popular questions and answers into a jrFaq module? It would be neat if the jamroomnetwork site worked like that.

Not out of the box, but it should be pretty easy to do. We just need to add a "views" that gets updated on each view, then we could run a jrCore_list to sort by views.

- Brian


_________________
Make sure and check out:
* The Jamroom FAQ
* The Jamroom Documentation

[SteveX]

That sounds cool. Views alone might not be the best way to go with it, might be best to let the developer arbitrate as to which ones are the relevant faq and which ones are just being gamed by numpties. But you know that already Brian.

@Douglas - are you updating your faq module for jr5?


_________________
Kulshi Mezian!

"Stranger from another planet, welcome to our hole. Just strap on your guitar and we'll play some rock and roll"

Ultrabubble create things.

[Michael]

We have the jrTags module on the docs, so you could tag it with FAQ.

5 star rating doesn't seam quite right to indicate which are "need to know". 5 star seams to indicate "How well was it written."


_________________
Michael Ussher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Dazed]

As I mentioned to you Michael I though a little bit of JR4 to JR5 changes would be good.

The things I am really looking for is the old JR functions and how they work in the new env.

Ranking be high on the list
Custom Form Fields
Debug procedures (mention to turn off popup blocker lol)
Also I think there are probably a lot of great features in JR5 that may go unnoticed. How about highlighting some of what you consider the coolest new features and why.
Examples of code is always good as well as scenarios/how to guides. ex. I want to add a custom form field to do this.

[SteveX]

Tags would work well, but as with the views, developer or admin weighting would be needed. Tag gaming (less words) would be pretty much the same as view gaming (no words), which is pretty much the same post gaming (lots of words).

I haven't seen it done yet, but I think I read that multiple ratings were possible earlier in the year.

Difficult to know, jr5 is moving on so fast it is hard to keep up, which reminds me of what I though of in the first place.....


_________________
Kulshi Mezian!

"Stranger from another planet, welcome to our hole. Just strap on your guitar and we'll play some rock and roll"

Ultrabubble create things.

[SteveX]

Overview of things before actual documentation. What jr5 does, in a nutshell. That's what I really want to read.

Also general descriptions - not only what jr5 does overall, but what it does with a song, what it does with a blog, what it does when an action is performed (clearly it runs an action function, but without description you might not know that, or even what an "action" is).

For developers (assuming we need more of them):
What it does with a single line of code in the module init (max, pending, actions, etc). = huge opportunity to demonstrate the power of it, and man is it powerful.
General (brief) description of capabilities of the system could also help people/siteowners to understand what jr5 does, and how to use it or how to talk to designers and developers about how they want it to work for them.

Code

{if !empty($jr)}    JR5: click it or not    Overview: 1 para catchy desc    Intro: 3 paras desc    Description: If that hasn't just been done it has already failed    Docs: whatever it takes {else}{*must be one part of jr5 in need of docs*}    {foreach}       WhatIsIt: click it or not       Overview: 1 para catchy desc       Intro: 3 paras desc       Description: If it hasn't just been understood then you don't need this feature       Docs: whatever it takes    {/foreach} {/if}

Non-beginner developers can just look at the code, it is incredibly clearly written, which anyone reading it can clearly see. Superb. But I bet a general overview would save much time for non-beginner developers as well.


_________________
Kulshi Mezian!

"Stranger from another planet, welcome to our hole. Just strap on your guitar and we'll play some rock and roll"

Ultrabubble create things.

[Michael]

Nice one Steve. Ill get on that now. thanks.


_________________
Michael Ussher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Douglas]

SteveX:

That sounds cool. Views alone might not be the best way to go with it, might be best to let the developer arbitrate as to which ones are the relevant faq and which ones are just being gamed by numpties. But you know that already Brian. @Douglas - are you updating your faq module for jr5?

Although you could probably use the jrAparna module to create a FAQ module fairly quick, the jrDocs module would also work well as a FAQ module, so I really didn't see a need to create a FAQ module.

Do we need a FAQ module for JR5?


_________________
Douglas Hackney
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center