Vanilla Tutorial/Documental Site

dodgerid · January 2012

I mentioned in a post a little while ago about vanilla having a wiki style documentation like another well know software publisher, simply because it attracts information from coders in a simplified form making it easier for novice programmers to find there legs within the code.

It was a great springboard for me and really got me into that software, even though all I knew about php before then was the syntax and the basics, what attracted me was the layman like examples of code that enabled me to build more than a hello world plugin and I got brave enough to actually write a cross site authentication plugin that allowed users to all be registered in one database and authenticate everywhere or for each site to replicate signups across the network of sites (and a few bits besides) but I could not have done it without the examples that made me brave.

Lots of people have good Ideas that never get programmed simply because as soon as they start looking at how a particular system works it gets confusing without good sign posts and they run.

What I am looking for is support for this idea as we all know the Vanilla crew are busy people, are there any app or plugin programmers out there willing to contribute to this site if i create it ?

Are there any people out there willing to help maintain it ?

What do you think of the idea ?

IMHO I think it could be a really good thing for vanilla in helping people build the confidence to give it a go.

What do you think ?

Link to Vanilla Wiki site:
http://vanillawiki.homebrewforums.net/index.php/Main_Page

hbf · January 2012

I'm up for helping. I don't have a lot of time, but I'd be happy to help edit and keep things clean where I can..

Jongos · January 2012

You got one vote from me...

dodgerid · January 2012

Thanks for your comments guys, still hoping some more people will show interest, although I'm thinking more interest might come when I set up the site, I'm learning loads right now and being simple myself (:)) I should be able to write a few tutorials.

Jongos · January 2012

I'm learning too, and keeping notes while at it.

Jongos · January 2012

@dodgerid

what if we just create a free account at vanillaforums.com and use that instead for a start.

hbf · January 2012

if you want to use this i just set it up for you.

http://www.homebrewforums.net/vanillawiki/index.php/Main_Page

Jongos · January 2012

:)

There you go... now who's gonna admin the page, and how are we going to organize the infos.

dodgerid · January 2012

Nice one @hbf

I will add my first page later, on signup it gave an unable to send verification email error but has allowed me to signup and in, I will have a read up later on adding categories etc.

dodgerid · January 2012

Ok, added some references to PHP and MVC with my own explanation but not sure if its in the right place or what. How would I ceate a page ?

I seem to have added it to the Discussion about the Main page !

Jongos · January 2012

Some input/opinion for consideration on the organisation of content, of how we should approach the documentation.

first approach : By Topics (Like vanillaforums.org/docs)

second approach : By Elements (Menu, HTML Header, Breadcrumb).

third approach : By Functions/Classes/Methods

fourth approach : By Tutorials (step by step guide)

The third approach doesn't have to cover all classes. Just the basic classes : Gdn_Pluggable, Gdn_Controller, Gdn_Model, etc.

Classes that doesn't matter much for purpose of creating addons, should have very low priority (Like factory related class)

dodgerid · January 2012

I think I am swayed towards the first approach, as familiarity with the way vanillas actual documentation is setout would help keep things simple for learners.

But also the third approach will be important as I think part of it needs to represent a reference to allow learners to find the things they need easily without having to trawl the code at first.

Obviously the tutorial section needs to be layed out simply with like a progression track as well as individual tutorials on some of the more imtermediate and advanced topics.

Not sure I understand the second approach for some reason lol dont know why.

It would be good if each area so to speak could be setup like the topic approach, I think its a good sensical approach to making it easy on the learner.

Jongos · January 2012

I mean, all those four approach are there.

On the main page, we show TOC of the first and fourth approach (Except with a link to another page with another TOC of classes and functions) so as not to scare the non-programmers.

When i say be elements, sometimes we (i mean at least me) have problems on a certain element, like for today I don't know how to create a menu. "Menu" is the element.

It's no use having only tutorials. lots of tutorials when one needs to solve at that instant is only how to create menu. so there has to be a menu page.

I've made some changes on the frontpage, next step i think would be to create a TOC list on the frontpage.

is that fine?

I guess the core dev wouldnt mind if we copy the TOC like on vanillaforums.org, like, how different can it be anyway...

Jongos · January 2012

@hbf

bro, a logo would be nice :) ... http://vanillaforums.com/blog/vanilla-logos/

Jongos · January 2012

@dodgerid

created a page for your MVC primer... http://www.homebrewforums.net/vanillawiki/index.php/Model-View-Controller_(MVC)_Pattern

dodgerid · January 2012

Wow, I'm glad your up for this idea, it's looking good already had a look at the logos, think the last one (sticker) would probably fit well.

I gotta say, i'm seriously impressed with your input, and the way your structuring it is spot on, could do with an events topic for event reference as I would happily put in the time to grep out and explain them.

Again, Seriously impressed, I think this will be a great addon to the community.

Jongos · January 2012

no big deal... :)

Any of the colored logo is fine with me...

I forgot about the events... added them...

I wonder if hbf wouldn't mind tweaking the css of the TOC a bit, add some right margin to it. It's hard to read the paragraph with TOC border almost touching it.

And the "Main Page" title too....

voila! structure has been laid out, now need contents :)

dodgerid · January 2012

How do you add code like this code,

and would it be an idea to use something like this : [http://www.mediawiki.org/wiki/Extension:GoogleCodePrettify](Google Code Prettify) ?

Jongos · January 2012

Have to wait for hbf and ask him to install extensions...

Some extensions for embedding Youtube videos would be good.

For example the videos on how to use Firebugs is a very useful addition to the wiki.

dodgerid · January 2012

Ok, is there a way to add code though or can it only be done via an extension

Jongos · January 2012

dodgerid said: Ok, is there a way to add code though or can it only be done via an extension

I'm not so familiar with Mediawiki myself... Searching user guides only show text on including HTML in articles

http://meta.wikimedia.org/wiki/Help:HTML_in_wikitext

I don't think the sanitizer would let PHP in that easy...

Why don't you try?

hbf · January 2012

dodgerid said: Nice one @hbf

I will add my first page later, on signup it gave an unable to send verification email error but has allowed me to signup and in, I will have a read up later on adding categories etc.

i ran out of steam last night so i didn't configure PHP mailer and a few other pieces. I'll do that today most likely.

As for extensions, just let me know what they are called and i will turn them on. I didn't enable any extensions last night, as it was my first media wiki install and i just wanted to see it run.

dodgerid · January 2012

Thanks, found it.

Sorry would have looked If I thought of it, baby girl sick at minute and i'm only getting on here 5 mins at a go, not much time to think at mo lol.

dodgerid · January 2012

@hbf ok mate.

hbf · January 2012

I'm just stopping in for a moment, I'll work it tonight after kids go to sleep.

Jongos · January 2012

@hbf

I forgot to thank you... The wiki already makes me feel better, feels like breathing fresh air from mountains, feeling alive, even though not much content in it yet.

Thanks mate.

as for the extensions :

http://www.mediawiki.org/wiki/Extension:YouTube_(Iubito)

http://www.mediawiki.org/wiki/Extension:GoogleVideo

hbf · January 2012

Jongos said: @hbf

I forgot to thank you... The wiki already makes me feel better, feels like breathing fresh air from mountains, feeling alive, even though not much content in it yet.

Thanks mate.

as for the extensions :

http://www.mediawiki.org/wiki/Extension:YouTube_(Iubito)

http://www.mediawiki.org/wiki/Extension:GoogleVideo

I hope it garners interest by more parties.

-- to any Vanilla.org staff - if you want to re-host this in the future just let me know.

As far a is know, the extensions have been installed. Give 'em a try.

Jongos · January 2012

@dodgerid

mate, can you take a look at http://www.homebrewforums.net/vanillawiki/index.php/Event_List

I've moved your list of event hooks there....

The original table is at the discussion page of the same topic : http://www.homebrewforums.net/vanillawiki/index.php/Talk:Event_List

See if it's okay because I removed the command column, maybe there's a reason you put the column in in the first place.

If all is good I want to clear the discussion page...

Let me know.

dodgerid · January 2012

Yeah, clear it mate, your doing a wonderful job, @jongos @hbf , your amazing guys the wiki is turning into exactly the sort of thing, the sort of way I envisioned in fact it's far better than I could have produced, Am very glad two seasoned pros have got involved, I think it really will connect vanilla to the masses, like I said above, there are plenty of people with good ideas and this will help them realise what it is they want to do, my hat is off to you both.

Oh, command column was just for a visual pointer if looking at the code, so decent explanations negate the need anyway, would have made more sense to put line numbers but they change to much.

dodgerid · January 2012

@hbf

Can we have the googleprettify extension please GoogleCodePrettify

422 · January 2012

Good work guys

Howdy, Stranger!

Categories

In this Discussion

Vanilla Tutorial/Documental Site

Best Answer

Comments