Joomla! Doc Camp Suggestions

Joomla! Documentation Workgroup
User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Joomla! Doc Camp Suggestions

Postby Chris Davenport » Mon Dec 31, 2007 10:17 pm

The first Joomla! Doc Camp will take place soon.

If you have any ideas about particular topics you would like to see documented, please add a description of what you'd like to see here.

Thanks,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

DanBollinger
Joomla! Intern
Joomla! Intern
Posts: 84
Joined: Fri Aug 17, 2007 11:18 pm

Re: Joomla! Doc Camp Suggestions

Postby DanBollinger » Tue Jan 01, 2008 12:33 am

Is there a table of contents or browse feature for the wiki? I'm having problems navigating it without resorting to random pages, a search, or tags. Dan

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Tue Jan 01, 2008 12:55 am

All currently available information on the Doc Camp is on this page: http://docs.joomla.org/index.php?title=Joomla%21_Doc_Camp

We're starting to put together a list of tasks on this page: http://docs.joomla.org/index.php?title=Doc_Campers_Start_Here

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

User avatar
severdia
Joomla! Guru
Joomla! Guru
Posts: 528
Joined: Mon May 01, 2006 4:34 pm
Contact:

Re: Joomla! Doc Camp Suggestions

Postby severdia » Tue Jan 01, 2008 6:44 pm

A while back, Macromedia put together a site called Pet Market where they showcased many popular features of their products all in one mock site. Then they developed a ton of case studies and tutorials around how users/developers could create the same functionality, etc.

http://www.adobe.com/devnet/blueprint/

What do you think about a series of tutorials (falling into the User/Admin/Web Designer categories) that would take a mock Joomla site and break down how easy it is to put together using step-by-step instructions?
Author | Speaker | Mad Scientist
Author of Using Joomla from O'Reilly Media | http://www.usingjoomlabook.com/
Shakespeare and Joomla | http://www.playshakespeare.com

User avatar
hotnuts21
Joomla! Explorer
Joomla! Explorer
Posts: 315
Joined: Wed Aug 17, 2005 11:11 pm

Re: Joomla! Doc Camp Suggestions

Postby hotnuts21 » Tue Jan 01, 2008 11:14 pm

For future reference, with a bit more forward warning I could put together a location for the UK. We have all the facilities available to do this. I *MAY* be able to get something organised before the 19th if someone can get in touch with me, but cannot guarantee it.

Incidently it will be based in Aberystwyth, Wales UK.



thnkx
Paul

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Wed Jan 02, 2008 12:01 am

severdia wrote:What do you think about a series of tutorials (falling into the User/Admin/Web Designer categories) that would take a mock Joomla site and break down how easy it is to put together using step-by-step instructions?

I like the idea.  It would take a bit of planning to make it work, but definitely one for the list.

Thanks,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Wed Jan 02, 2008 12:50 am

hotnuts21 wrote:For future reference, with a bit more forward warning I could put together a location for the UK. We have all the facilities available to do this. I *MAY* be able to get something organised before the 19th if someone can get in touch with me, but cannot guarantee it.

Incidently it will be based in Aberystwyth, Wales UK.

Sorry about the short notice.  If this event is successful we will probably run another later in the year and we'll be able to give more notice for that.  If you can put something together for the 19th that would be great.  Sending you a PM.

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

User avatar
DesignGuy
Joomla! Explorer
Joomla! Explorer
Posts: 263
Joined: Sat Sep 02, 2006 9:33 pm
Location: Chicago, USA
Contact:

Re: Joomla! Doc Camp Suggestions

Postby DesignGuy » Wed Jan 02, 2008 2:31 am

We can work on a Chicago location for an upcoming event.
John Coonen
Host, CMS Expo Learning & Business Conference - http://CMSExpo.net
Managing Director, The CMS Connection - http://CMSConnection.com
Co-founder, JoomlaChicago

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: Joomla! Doc Camp Suggestions

Postby AmyStephen » Wed Jan 02, 2008 3:02 am

Chris -

I might have missed this on the wiki, but is there a place for those intending to participate to sign up? Particularly, if there is not a physical location? Or, even if we want to offer a physical location if others in our area are interested?

Thanks for this great idea and way for us to participate,
Amy :)

yma981
Joomla! Apprentice
Joomla! Apprentice
Posts: 5
Joined: Tue Nov 13, 2007 12:22 pm

Re: Joomla! Doc Camp Suggestions

Postby yma981 » Wed Jan 02, 2008 9:45 am

Hello Joomla!'s Heroes

I have a suggestion for you. Why don't you try to build a comprehensive Walkthrough that takes new comers like me in the whole process of building, optimizing a website (a real example) and learning the multiple joomla fields (templates, backend, frontend, components, modules etc...).

Thank you
Reagrds
YMA


Mod note: Manual signature removed. Please add signatures in your profile and not to each post.
Last edited by brad on Fri Jan 25, 2008 12:11 am, edited 1 time in total.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Wed Jan 02, 2008 4:05 pm

DesignGuy wrote:We can work on a Chicago location for an upcoming event.

That would be cool.  Let me know if there's anything we can do to help.

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Wed Jan 02, 2008 4:16 pm

AmyStephen wrote:I might have missed this on the wiki, but is there a place for those intending to participate to sign up? Particularly, if there is not a physical location? Or, even if we want to offer a physical location if others in our area are interested?

You just need to register on the wiki (here's a quick link: http://docs.joomla.org/index.php?title=Special:Userlogin&type=signup).  As an anti-spam measure you need a valid email address to complete the registration process.  That gives you write access to the wiki.

If you wish to be present at one of the physical locations you need to visit the appropriate website and register there as these events are being run by local community members.  Right now only Vancouver has that facility, but others will follow soon.

If you want to offer a physical location you don't need to do anything special (except organise it!) but it makes sense to let me have the details so I can help spread the word!  That includes being listed in the official announcements.

Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Wed Jan 02, 2008 4:24 pm

yma981 wrote:I have a suggestion for you. Why don't you try to build a comprehensive Walkthrough that takes new comers like me in the whole process of building, optimizing a website (a real example) and learning the multiple joomla fields (templates, backend, frontend, components, modules etc...).

Yeah, I think that's a good idea.  It sounds a lot like severdia's suggestion earlier in this thread where we have one or more sample/demo sites setup then we write tutorials which take the reader step-by-step through the process used to create them.  I think it could work although it would require quite a bit of upfront planning.  Is that the kind of thing you had in mind?

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

Jonathan Cameron
Joomla! Apprentice
Joomla! Apprentice
Posts: 34
Joined: Wed Sep 12, 2007 7:55 pm
Location: Pasadena, California

Re: Joomla! Doc Camp Suggestions

Postby Jonathan Cameron » Sat Jan 19, 2008 4:42 am

Here are few things I would see better documentation for:

  - More details about how to create a editors-xtd plugin.  For instance, once you are in
    the onDisplay call-back code, how can you get the article id?  How do you surpress
    the display of your button dynamically (I figured this one out).  How can you
    display something above or below the article editing area?

  - How to construct a patch file (assuming this is possible):  A file that you upload through
    the install/uninstall extensions system that would replace an existing file with an updated
    version.  This would simplify creating patches for existing extensions that only require
    that files be modified.

  - Better documentation of the various types of things that can be done via custom
    plugins.

Thanks!

    -Jonathan

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Sat Jan 19, 2008 9:58 am

Jonathan Cameron wrote:... once you are in the onDisplay call-back code, how can you get the article id?

Sounds like a job for JFactory.  Writing about JFactory is on the task list.  If you find answers to your questions (and I don't know the answers), perhaps you could write up some notes that might form the basis of some documentation.

Jonathan Cameron wrote:  - How to construct a patch file (assuming this is possible):  A file that you upload through
    the install/uninstall extensions system that would replace an existing file with an updated
    version.  This would simplify creating patches for existing extensions that only require
    that files be modified.

Upgrading of extensions is not supported in 1.5, although I believe some hooks are there for future use.  Hopefully someone will write a white paper proposal for this so we can get it into a future version of Joomla!

Jonathan Cameron wrote:  - Better documentation of the various types of things that can be done via custom
    plugins.

Write ups for most of the plugin types are already on the Doc Camp task list.  Just need to find the authors to write them. :)

Thanks for you comments.  We'll try to make it happen.

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

avdkooij
Joomla! Apprentice
Joomla! Apprentice
Posts: 45
Joined: Thu Dec 29, 2005 8:31 pm

Re: Joomla! Doc Camp Suggestions

Postby avdkooij » Mon Jan 21, 2008 10:04 pm

maybe a usefull suggestion:

Categorize all wiki-pages in either "end-user documentation" or "developer documentation".
- End-user documentation would be used as input for all documentation found on help.joomla.org, the help screens in the joomla-site administrating back-end, etc.
- Developer documentation would be placed at dev.joomla.org, for those designing /coding third party extensions (templates, modules, components) and/or the joomla core.

I expect documentation for these two groups, differs a lot in e.g. learning curve, writing style etc.
If usefull, i am willing to help categorizing the current pages in de wiki...
Last edited by avdkooij on Mon Jan 21, 2008 10:05 pm, edited 1 time in total.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Thu Jan 24, 2008 1:50 am

Hi avdkooij,

Actually we are deliberately going in the opposite direction at the moment by blurring the previous distinction between user and developer documentation.  That's because we have found that there is quite a bit of overlap with some user documentation being of use to developers and vice versa.  Consequently we are gradually centralising the documentation and we will also be trying to modularise it so that it becomes more re-usable.  We can still retain user/developer tags in the form of wiki "categories", but these are more like hints than hard-and-fast divisions.

This does not mean that we will be doing away with help.joomla.org or dev.joomla.org, but it is likely that the documentation areas that they contain will be derived from the central docs.joomla.org instead of being "original".

If you want to help us in the documentation effort, then please register on docs.joomla.org and get started on any task that takes your fancy. :)

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

avdkooij
Joomla! Apprentice
Joomla! Apprentice
Posts: 45
Joined: Thu Dec 29, 2005 8:31 pm

Re: Joomla! Doc Camp Suggestions

Postby avdkooij » Thu Jan 24, 2008 10:14 pm

great to see that the doc group is approaching Joomla's documentation in such a professional way. Tactics for handling the user / developer overlap, the modulated documentation, etc. You guys are doing an amazing job!

User avatar
radiant_tech
Joomla! Guru
Joomla! Guru
Posts: 531
Joined: Sat Dec 15, 2007 3:02 pm
Location: Washington DC Metro

Re: Joomla! Doc Camp Suggestions

Postby radiant_tech » Tue Jan 29, 2008 9:29 am

After reading the existing MVC tutorials (J! 1.5), I still needed to clarify the file structure and naming conventions of such a component.  I tried to add this to the Doc Camp list, but apparently used an "impossibly long title".  :-[  True enough.  However, the page has been redirected simply to "Naming Conventions", a title I don't believe is wholly appropriate either.

I've added {{review}} to the top of the page -- so I'm hoping this will be categorized more correctly.  Is there another, better way I should have gone about this?  Another location or forum thread where I could have asked for help with a more appropriate title?

While I'm happy to continue to contribute to documenting 1.5, this was rather like having a door slammed in your face and left wondering where to go next.

Thanks.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Joomla! Doc Camp Suggestions

Postby Chris Davenport » Tue Jan 29, 2008 4:37 pm

Hi radiant_tech,

Apologies if you felt like we were slamming a door in your face.  There will likely be a lot of changing of titles, moving stuff around, breaking things into smaller modules, etc., to come.  The contents of the wiki are pretty haphazard at the moment, following the Doc Camp event, and we need to develop a structure and get stuff organised into that structure.  Please don't be offended if that happens to something you've written.  It's nothing personal.

Thank you for taking the time to contribute to the project.  We really do appreciate such efforts.

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

User avatar
TSX-Today
I've been banned!
Posts: 57
Joined: Wed Dec 19, 2012 6:56 pm
Location: Vancouver, BC, Canada
Contact:

Re: Joomla! Doc Camp Suggestions

Postby TSX-Today » Tue Mar 19, 2013 8:05 pm

Will there be something like this for the new versions? Thanks
My SEO Website at SEO Vancouver http://www.seoinvancouver.com/
TSX Today http://www.tsx-today.com/ , ranks one Page #1 in Bing and Yahoo for super competitive keyword: TSX, with over 500,000 searches per month


Return to “Documentation - Feedback/Information/Suggestions”

Who is online

Users browsing this forum: No registered users and 3 guests