User Manual Suggestions

Locked
kismert
Joomla! Intern
Joomla! Intern
Posts: 73
Joined: Thu Jul 27, 2006 12:16 am

User Manual Suggestions

Post by kismert » Tue Aug 01, 2006 12:02 am

Hello, Document Team!

I have two suggestions:

First

Under System Requirements, page 7, the manual says:
You need to be sure that your web server, or the service provided by your web host, meets the minimum requirements before you download the Joomla! software. These are:
  • ...
  • You must ensure that you have MySQL, XML and Zlib support built into your PHP.
The first three requirements are easy to verify. But before installation, it can be difficult, especially for a newbie, to determine what modules PHP was installed with, expecially on hosted sites.

You can safely remove that last requirement on Page 7, because the Joomla! browser install does this for you during the Pre-Installation Check, on page 9.


Second

On page 8, the last paragraph starts with:
When you have finished uploading the files and folders, go to your homepage,
http://www.yoursite.com or http://yoursite.com/Joomla!_folder.
New users may decide that "Joomla!_folder" is a good subdirectory name, given this example. Unfortunately, the "!" is an invalid character for Linux directory names. Naming your install folder "Joomla!_folder" will cause the installation process to fail.

Please change the suggestion to "http://yoursite.com/joomla", which seems to be the commonly used, safe default.

Thanks for your hard work,

-Ken
Last edited by Michelle Bisson on Wed Oct 25, 2006 3:14 am, edited 1 time in total.

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: User Manual Suggestions

Post by Michelle Bisson » Wed Aug 02, 2006 3:34 am

kismert,

Are you available to help with the User manual project?  Right now we have no one to work on it.
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

kismert
Joomla! Intern
Joomla! Intern
Posts: 73
Joined: Thu Jul 27, 2006 12:16 am

Re: User Manual Suggestions

Post by kismert » Wed Aug 02, 2006 7:50 am

Hello, Michelle:

This is also in response to my post http://forum.joomla.org/index.php/topic,82068.0.html.

I am tempted by the offer. Part of my current paid job is to help implement a Joomla! site, so I will be trying to learn a lot about the package in a short time.

Right now, I can't in good faith commit to a long documentation project. However, if I find some free time, it shouldn't take too long to edit the current User Manual.

Fixing the Manual Install might take longer, because SQL scripts would have to be updated.

Making the Joomla! Installer more informative would be a worthy longer-term goal, but would involve developers as well as documenters.

I've looked at your volunteer posts, and have some questions:
  • What format is the source documentation in?
  • How do you collaborate?
I have co-authored articles in computer journals, so I have some writing experience. Despite my sometimes stern tone, you'll find me easy to work with  :P

If our company commits to Joomla! as one of its long term platforms, I'd definately like the opportunity to contribute back to the project.

-Ken

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: User Manual Suggestions

Post by Michelle Bisson » Thu Aug 03, 2006 3:55 am

    * What format is the source documentation in?
The User manual 1.0.x has been written bye LedZep using MS Word that I converted to .pdf.  I would like one day to have it published directly on the Help site.  But it takes someone (or a team) to do that.  On top of tha,t if we have both formats available, we have write and keep updated the manual in two formats.

So for now, I would be happy if one or a few 'new' volunteers finish the current manual.  But we now have 1.5.x almost ready to be released, so we need people to write that too.

    * How do you collaborate?
Those who would like join the gen. doc team must be able to commit 3 to 5 hours/week on a regular bases.

Those who are not able to commit can still volunteer to write and proof-read and post their suggestions here on the forum. I will just communicate with them using this forum.

Anything related to the Help Screens, I try to publish the corrections and suggestions on the Help Site.

Anything related to the User Manual, - please publish them here, but right now I do not have anyone to update the .pdf version.
So if someone (or a couple of people) wishes to volunteer for that, that would be great!

Just let me know if you are available and what you would like to do.

Thanks in advance!
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: User Manual Suggestions

Post by Michelle Bisson » Mon Oct 23, 2006 7:08 pm

Please visit our new User Manual forum. 

http://forum.joomla.org/index.php/board,352.0.html

Thanks!
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member


Locked

Return to “Archive”