Umbraco documentation update project Options
ferret
Posted: Wednesday, January 23, 2008 5:17:06 PM

Rank: Enthusiast

Joined: 1/10/2008
Posts: 25
Location: Nottingham, UK
A lot of people, myself included, are of the opinion that Umbraco needs better documentation. Therefore, I have been talking to Niels about updating the PDF manual for Umbraco 3. The current manual has a lot of spelling and grammar mistakes (I am assuming that is down to translation) and probably needs refreshing for v3.

The PDF I mean is by Kasper Bumbech Andersen and is dated 12/2005. If Kasper is reading, you have done a great job of all the screen grabs in the manual, good work :P

So, my plan is that we all get our heads together (especially the n00bs!) and put together an updated and proofed English manual. I am also keen to do one for the Creative Website Package, and perhaps another, showing how they link together. Documentation is key to any project, and hopefully updating the manuals will help lots of other new users get up and running as fast as possible :)

Nick



Nottingham web design and green hosting - FCS Websites
Umbraco documentation wiki - Come and join in!
pkoutoul
Posted: Wednesday, January 23, 2008 5:54:25 PM

Rank: Fanatic

Joined: 8/9/2007
Posts: 284
Location: Kentucky, USA
Good idea, Nick. Since I have been one of those folks complaining about the lack of documentation, I should be willing to help out!

How are you thinking this would be managed?

Pete Koutoulas • Fayette County Public Schools • Lexington, Kentucky
warren
Posted: Wednesday, January 23, 2008 6:07:40 PM

Rank: Addict

Joined: 7/19/2006
Posts: 777
Location: Leigh-on-Sea, Essex, UK
Hiya Nick.
It would really help me out if you could write the Website Creative package documentation, as I keep putting it off at the minute.

Add me to msn to discuss: warren(at)NOSPAMcreativewebspecialist(dot)co(dot)uk

Warren

Warren Buckley an Umbraco MVP 08-09 & level 1 certified developer
ferret
Posted: Wednesday, January 23, 2008 7:51:30 PM

Rank: Enthusiast

Joined: 1/10/2008
Posts: 25
Location: Nottingham, UK
Pete: Excellent, that's the spirit :D

I have no idea how to manage it... any suggestions? Some kind of Wiki?

Warren: Sounds good, I have added you to MSN. Will email you too as I don't go on MSN that much ;)

Nick

Nottingham web design and green hosting - FCS Websites
Umbraco documentation wiki - Come and join in!
pkoutoul
Posted: Wednesday, January 23, 2008 8:16:46 PM

Rank: Fanatic

Joined: 8/9/2007
Posts: 284
Location: Kentucky, USA
Yes, I would think a wiki would be the best way for several people to collaborate. I know there is already an umbraco wiki but it is quite dated.

Pete Koutoulas • Fayette County Public Schools • Lexington, Kentucky
agiliti
Posted: Thursday, January 24, 2008 2:45:13 AM
Rank: Enthusiast

Joined: 12/26/2007
Posts: 11
Hi,

I would be happy to help with the docs. I think the wiki is a good idea. I'm happy to set up a wiki site if you want to go that way.

Cheers,
Peter

Brisbane Web Design - web design | web development | internet marketing - Agiliti Solutions
ferret
Posted: Thursday, January 24, 2008 4:59:23 PM

Rank: Enthusiast

Joined: 1/10/2008
Posts: 25
Location: Nottingham, UK
Hi,

Peter: Thanks for the offer but I set up a MediaWiki last night in a fit of excitement :) Do you think that will be ok for our purposes?

Pete: Yes do you mean the Wikibooks Umbraco site? It does seem a bit unloved. Maybe we should all update that as well!

Nick

Nottingham web design and green hosting - FCS Websites
Umbraco documentation wiki - Come and join in!
pkoutoul
Posted: Thursday, January 24, 2008 6:49:16 PM

Rank: Fanatic

Joined: 8/9/2007
Posts: 284
Location: Kentucky, USA
I'm not familiar with MW but I'm sure a wiki is a wiki... Let us know when you are ready to dive in.

Pete Koutoulas • Fayette County Public Schools • Lexington, Kentucky
agiliti
Posted: Friday, January 25, 2008 9:16:01 AM
Rank: Enthusiast

Joined: 12/26/2007
Posts: 11
Hi Nick,

Sounds like that will do fine.

Btw, I've been in the process of putting together a wiki offline for storing links and snippets I find in the forum for my own use. There's a lot of good information floating around but it's scattered everywhere. Later on I plan to launch the wiki live with links/RSS feeds to the various blogs & official docs/books etc. The wiki will support syntax highlighting of code and XSLT etc. I'm hoping to do such a great job at it that it will attract interest and get updated frequently. Stay tuned.

But back to the topic of creating a v3 manual, keep me posted .... will you be setting up some categories in the wiki that map to the document ? We can then add comments on what needs to be updated/added etc. as a first step perhaps...


Cheers,

Peter



Brisbane Web Design - web design | web development | internet marketing - Agiliti Solutions
ferret
Posted: Monday, January 28, 2008 10:19:29 PM

Rank: Enthusiast

Joined: 1/10/2008
Posts: 25
Location: Nottingham, UK
Ok, I have wrestled MediaWiki into submission and it's now up and behaving at [url=http://www.fcswebsites.co.uk/wiki/index.php?title=Main_Page]Umbraco Documentation Wiki[/ur]

An Umbraco theme is in progress :w00t:

Especially interested in the contributions of complete n00bs to Umbraco - I am going through hell and back with .NET and permissions, so I feel it would be super useful for everyone to chip in their own experiences and make a comprehensive manual.

So come on over, sign up and get stuck in :yes:

Nick



Nottingham web design and green hosting - FCS Websites
Umbraco documentation wiki - Come and join in!
ferret
Posted: Monday, January 28, 2008 10:20:27 PM

Rank: Enthusiast

Joined: 1/10/2008
Posts: 25
Location: Nottingham, UK
And that URL again kids:

Umbraco Documentation Wiki

:blush:

Nottingham web design and green hosting - FCS Websites
Umbraco documentation wiki - Come and join in!
pkoutoul
Posted: Tuesday, March 18, 2008 3:31:24 PM

Rank: Fanatic

Joined: 8/9/2007
Posts: 284
Location: Kentucky, USA
What is the status of this project? I would like to contribute if it is going to be maintained but I don't see much of anything there as of today.

Pete Koutoulas • Fayette County Public Schools • Lexington, Kentucky
Users browsing this topic
Guest


You cannot post new topics in this forum.
You cannot reply to topics in this forum.
You cannot delete your posts in this forum.
You cannot edit your posts in this forum.
You cannot create polls in this forum.
You cannot vote in polls in this forum.