Hi everyone, I just had a look at what documentation we have and where to see what needs to be done for the release. Below are my notes - this is a broad overview, I haven't actually checked the details of any documentation files, just what we have and where we have it, and if it is obviously outdated or duplicated.
I would prefer not to just delete documentation which is not appropriate for
the release (such as the old Widget Dev Guide doc in Word), but I'm not sure it
really still belongs in trunk - should we put it somewhere else in SVN?
S
Documentation in SVN
==================
readme_coppercore.txt : This is kind of useful for a few people but is pretty
obscure stuff. I suggest moving this to the CopperCore project instead. It
should not be included in the release.
readme_tomcat.txt : This is no longer consistent with the "Downloading and
Installing Wookie" wiki page and hasn't been updated in a long while. I suggest
deleting this.
readme.txt : This has similar content to the "Downloading and Installing
Wookie" wiki page but is not identical. I suggest we merge the content of this
into the wiki and write a new README.txt specifically for the release.
/tutorials/firstWidget.odp : A tutorial for use with sample code. Needs testing.
/docs : Both .doc files in here are really old - we might repurpose some of the
content for future documentation but they should not be in a release as they
will really confuse users.
/connector/README.txt : Very brief, just a description of what the connector
framework is, and a link to the Embedding Wookie Widgets wiki page.
/connector/ruby/README.txt : Very brief installation information. Needs a link
to the Embedding Wookie Widgets wiki page.
/connector/php/README.txt : Very brief installation information. Needs a link
to the Embedding Wookie Widgets wiki page.
/connector/flash_flex/README.txt : Just a sentence on what it is. Needs a link
to the Embedding Wookie Widgets wiki page.
Documentation online
=================
Downloading and Installing Wookie: All sections look complete; needs testing.
(The section on "Running Wookie with a security manager" is likely to be out of
date since we stopped using Hibernate)
Wookie Server Administrators Guide: This has a lot of placeholders and needs
more work.
Embedding Wookie Widgets: There are a few sections here that are missing, but
the main material on the connector framework looks OK. Needs testing.
Building Widgets : All sections look complete; needs testing.
Using Wookie's W3C Widget Parser in other Applications : The stylesheet has
made the code samples unreadable; content also needs testing as I suspect not
all parameters are documented.
Integrating Wookie with Shindig : Looks pretty complete. Needs testing.
FAQ : This looks to be in good shape.
Wookie REST API : Needs testing - some of this may no longer be 100% up to date.
Documentation Missing from Wiki?
===========================
The Bondi Camera feature doesn't have any documentation or a link to any
documentation. It may also benefit from having a README.txt in SVN.
Documentation Missing from SVN?
===========================
I noticed that while the other connectors have readme files, these don't. May
be worth adding for completeness, even if its just "This is a Wookie connector
written in {python|java}. For more information see {Embedding Wookie Widgets
URL}"
/connector/python
/connector/java
/connector/CSharp
smime.p7s
Description: S/MIME cryptographic signature
