ODF@WWW/Milestone I

From Apache OpenOffice Wiki
Jump to: navigation, search
ODF@WWW Logo small.png
Milestone I - "Get Started"

First goal for the ODF@WWW effort must be, to "release" something which has been properly checked-in and which has some kind of feature set, which seems to be usable. It is not yet the goal to conquer the world ;-) but just to get the basics in place.

Organization

Become an Incubator Project

For the ODF@WWW to get any official status, it needs to become a so called "accepted project". Projects on OOo are things as Uno or the Writer. Before any project can become an accepted project it needs to be an "incubator project", basically proven it's viability etc. Even incubator projects need to be discussed first on the OOo lists, see http://www.openoffice.org/about_us/protocols_proposing.html for how-to creating an incubator project.

This task is done, ODF@WWW by now is an official incubator project hosted at

http://odf-at-www.openoffice.org

You may want to look at my respective Blog posting for some details.

Set up an ODF Wiki

Set up an ODF Wiki to used for the Project itself, e.g. something as

 http://odf-at-www.services.openoffice.org

This basically is to "eat your own dog food". To do the full step, the documentation then also needs to be moved from the OOo Wiki into the ODF Wiki.

Setting up an ODF Wiki requires the availability of at least basic user authentication and a simple means of document back-up / transactionality.

Check-In the Prototype

Download prototype from Mediacast and check it in into the project repository.

The prototype has now been checked in. Unfortunately sym.links don't work for CVS, workarounded within a script. The following scripts are now available:

README
files.sh
Lists all files to be installed de-installed.
install.sh
Copies all files from current location to target, creates needed sym. links.
un-install.sh
Removes all previously created files.
copy-back.sh
Copies installed files back into this source directory.
pack.sh
Creates a .tgz with all needed files suitable for Linux and Solaris.

Write a Pack Script

Write a script to "package" the ODF Wiki.

Features

Support Mac OS X Clients

Support for Mac OS X Clients.

User Authentication

Users need to login to be able to save documents. Apache.org has some documentation on this. One may either use HTTP Basic authentication or HTTP Digest authentication. See http://httpd.apache.org/docs/2.0/mod/mod_dav.html.

Configured and implemented "Basic" authentication using a simple password file. Needs to be reworked later for something more secure.

Basic Versioning

As document saving does not seem to be reliable in all cases, use a snap shooting or versioning mechanism backing up all stored documents.

There are various version control systems out there, such as CVS, Subversion, Mercurial, GIT etc.

Luckily Subversion directly supports webDAV and so called hooks or trigger scripts. First experiments seem to show that this may integrate well with the current ODF Wiki implementation.

Documentation

Update the provided documentation:

  • Add links to latest Blog posting.
  • Add links to the project page.
  • Review documentation.

Tasks

ID Title Owner State
1 Organization
1 Become an Incubator Project
1 Draft a short proposal. Kay done
2 Submit it to the Incubator lead, Louis Suarez-Potts for review. Kay done
3 Advertise that proposal on the relevant lists and on discuss@openoffice.org. Kay done
4 Ask for a vote on the merits of the project. Kay done
5 Create the project. Kay done
6 Prepare project pages Kay done
2 Set up an ODF Wiki
1 Set up a publicly accessible ODF Wiki. Kay done
2 Moves pages from OOo Media Wiki into the ODF Wiki. Kay open
3 Check-In the Prototype
1 Check-in Prototype Kay done
2 Pack Script Kay done
2 Installation Script Kay done
2 Features
1 Support Mac OS X Clients Kay open
2 User Authentication Kay done
3 Basic Versioning Kay in progress
3 Differentate Cache from Content Kay done
3 Documentation
1 Add latest Blog postings Kay open
2 Add links to Project Page Kay open
3 Review Documentation Kay open
Personal tools