On 01/10/11 09:23, Gareth McMullin wrote:
Hi All

I'm new here.  I'm taking a course on technical documentation and would
like to contribute.

I found some minor issues with the SQLite How-To on the OOo wiki:
http://wiki.services.openoffice.org/wiki/Documentation/How_Tos/Using_SQLite_With_OpenOffice.org

I've put some notes on the discussion page.  I would like to make some changes
primarily to the Linux installation section, but I'm interested in
your comments/discussion first.

Should I enter an issue in the Issue Tracker?  If so, how do I take
ownership of the issue?


Hi Gareth.

First thing... I've bumped up your access on the Doc Project pages - you probably won't need it (we do most of our doc work outside of the old Doc Project web pages), but you've got Content Developer status there.

You're welcome to edit the Wiki page directly - especially if you have some knowledge on the topic, and can test the documentation eg test installing SQLite and configuring to use with OOo. There is no need for an issue in the Issue Tracker unless you find it helps you personally manage the changes. Taking ownership on the Wiki is simply a case of getting in there and editing the content. Letting people on the team know via the mailing list is generally enough.

You're right in your comment, the instructions are Ubuntu/Debian specific. Where I can, I try to cover both DEB and RPM based distros - that still leaves out ones like Gentoo and Arch, but... you cannot cover every single variation. If we hit the two major ones, we've got most covered.

Where I can't cover all distros, I like to adjust the wording so that it's a little more generic. For example:

------------
You can install unixodbc with your packetmanager - or download the sources from the unixODBC website. The unixodbc-dev and unixodbc-bin packages will also be required to complete the configuration for OpenOffice.

sudo apt-get unixodbc unixodbc-dev unixodbc-bin
------------

Could be re-written something like this (leaving out the apt-get line, and correcting the package manager reference, minor punctuation, and OOo name):

------------
You can install unixodbc with your package manager, or download the sources from the unixODBC website. The unixodbc-dev and unixodbc-bin packages will also be required to complete the configuration for OpenOffice.org.
------------

There are other minor errors and assumptions throughout the page that could be cleaned up as well.

C.
--
Clayton Cornell       [email protected]
OpenOffice.org Documentation Project co-lead

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to