Editorial Board Meeting November 2007

Do we want to settle on a single common language for screenshot examples on doc.tw.o, or allow any language the author happens to be using?

- More for consistency than anything, is there any policy or practice that is used for documentation language as a baseline? By and large, most folks accept that documentation will be written in english first for most things since that appears to be a common denominator. The great thing about Tiki is that there is built-in language translations - unfortunately that does not apply to screenshots. I was looking at the documentation for a feature called Contribution, which seems pretty cool. I could read the english version of the page, but the screenshots were in what I guess is Spanish since xavi appears to have written the page (and the feature?). I don't understand a lick of Spanish, so it's hampering me from understanding the examples completely. My question is do we want to settle on a single common language for screenshot examples on doc.tw.o, or allow any language the author happens to be using? (xavi, would love to hear more about this feature...I might be able to use it at work)


Discussion: I've previously tagged some non english screenshots as needing updates. I'm also grateful for any help we get with docs. dthacker

Proposal for documentation page formatting...

This really stems from 1.9 vs. 1.10. I would like to propose an "Information" sub-section on each doc page relating to features/mods/etc which would contain sub-headings with related information like:

Import forums

Blurb about what the feature does.

Change Log

Outlines significant changes in the appearance or behaviour of the feature...

1.9.8.3 - Introduced.
1.10.0 - Added ability to import directly from another DB server.
1.10.1 - Able to now migrate phpBB3 forums.
1.11.0 - Removed SQL dump import option because seldom used.

Known Issues

1.9.8.3 - Only works with mysql for sql dump import.

Examples

blahblahblah....

Discussion:

• You could make that "Starting Now we do it this way", but resources for feature archeology are usually not available. dthacker

Opposed: dthacker

Identify with a caption the version of Tiki each screenshot is from, with the goal of the screenshots matching either the current release, or the current release candidate, whichever is more imminent

In the case of today, we would try and get all screenshots current as of 1.10.0 until we come up with a 1.10.1 down the road. The Change Log proposed above will fill in the blanks. Maybe also have a "-HEAD" version of the page that talks about and documents changes to an existing feature that are in development in the head branch. When the time comes, those details can be easily incorporated into the current release page. Obviously, if the feature doesn't exist yet, then instead of ahving a -HEAD version (for example Contributions-HEAD), then it'll just be the name of the feature (Contributions) and in the Change Log section we'd have "1.11.0 - Introduced". I think we need to document new features that are being developed, but keep it separate from what is current so as to avoid confusion.

• All screenshots should have a standard caption including version. We could add an "under development" tag as the equivalent to HEAD.(dthacker)

In Favor: dthacker

Ok, the windbag is empty. Would love your thoughts on these. They are all meant to make it easier for users to identify what feature goes with what version of Tiki. Ideally each Feature would have its own 1.9.7, 1.9.8, 1.10.0 versions, but I think that'd be a ton of work, and besides which we've got page histories folks can view for the older version they want as long as the changes are beig documented in the comments.