MetaWiki

From Omar Wiki

Jump to: navigation, search

Contents

[edit]

Overview

This page is for all issues related to how to improve the freebXML Registry Wiki.

[edit]

Guidelines for Page Design

  • Page name should be lowerCamelCase
  • Each page should be referenced by at least one other page. We should have no unrefernced links ideally.
  • New features should have a design page as well as a users guide page. These pages should be started when feature work begins and incrementally updated as the feature gets implemented.
[edit]

Wiki Layout

The following bullet tree describes the organization our Wiki. Sub-bullets are sub-directories.

  • spec - root for all pages related to ebXML Registry or JAXR specs.
    • jaxr
    • regrep
  • dev - root for all pages targetted to developers
    • omar - root for all pages whose primary target audience is freebXML Registry dev team
      • process - root for all pages describing team processes. Need to refactor patch, review, commit process etc here from omar web site.
      • design - root for all pages that are design documents for freebXML Registry features
      • Move following pages under here: ServerCache, RegistryPlugin
    • tools - root for all pages that describe developer tools for freebXML Registry
      • netbeans
        • profiler
      • proposals - root for all pages that describe proposals for new features in freebXML Registry
    • client - root for all pages related to custom registry client development. This sub-tree is focused on end users rather than omar developers who have their own tree under omar-dev
    • plugin - root for all pages that decsribe registry plugin dev.


  • deploy - root for all pages related to deployment time issues for freebXML Registry
    • database - root for all pages related to databases for deploying freebXML Registry
    • container - root for all pages related to containers for deploying freebXML Registry
    • os - root for all pages related to operating systems for deploying freebXML Registry
    • performance - root for all pages related to performance of freebXML Registry
    • scalability - root for all pages related to scalability of freebXML Registry


  • run - root for all pages related to runtime isues for freebXML Registry
  • showcase - root for all pages that show case how the registry is being used. Current CaseStudy tree moves here. Conference papers on omar are encouraged to be linked from here.
[edit]

Moving Web Site Content to Wiki

We need to move more content from web site to wiki. Here is a proposal in priority order:

[edit]

Priority 1: Dev Team Processes


Web Site page Wiki Page Owner Status of Migration
Bug and RFE Fix Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/process/bugFix Done
Patch Submission Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/process/patchSubmission Done
JUnit Test Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/test/unit (requires refactoring and merging into existing content in this page) Done
[edit]

Priority 2: Installation and Setup Guides

Web Site page Wiki Page Owner Status of Migration
Server Setup Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Install (requires refactoring and merging into existing content in this page) Done
Using HTTPS Split into following pages: Tomcat specific goes under new section: Configuring HTTPS http://ebxmlrr.sourceforge.net/wiki/index.php/Deploy/container/Tomcat . Not sure that we need all the remaining content. Needs to be examined. Done
[edit]

Priority 3: End User Guides

Web Site page Wiki Page Owner Status of Migration
Features http://ebxmlrr.sourceforge.net/wiki/index.php/Overview/features . Just have a table of contents here with one line summary and link to deeper content elsewhere. Discuss location of the 'elsewhere' on teamlist first. Done. Needs to be much improved.
Registry Browser Web UI User Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Run/webUI Done. Missing pictures
Registry Browser Java UI Tutorial http://ebxmlrr.sourceforge.net/wiki/index.php/Run/javaUI Done. Missing pictures
User Registration Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Run/userreg
[edit]

Priority 4: Admin User Guides

Web Site page Wiki Page Owner Status of Migration
Logging Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Admin/logging
Property Configuration Guide http://ebxmlrr.sourceforge.net/wiki/index.php/admin/configure
Browser Configuration Guide http://ebxmlrr.sourceforge.net/wiki/index.php/Admin/configure
[edit]

Priority 5: OMAR Developer Documentation


Web Site page Wiki Page Owner Status of Migration
Admin Tool ? Configuring and extending the admin tool http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/design/adminTool
Debugging ? Debugging the client, the server, or both http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/debug (need to link to existing page http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/tools/netbeans )
Using NetBeans ? Setting up and using the NetBeans IDE to edit and debug the registry Harmonize and merge within http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/tools/netbeans
Adding a Package ? Adding a package that you can compile and run using package-specific Ant targets http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/design/adminTool/ant
Working with Bindings ? Working with bindings that were generated using JAXB http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/code/jaxbBindings
Adding a new RIM class ? Adding a new type to code when RIM is updated http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/code/addNewRIMType
Coding Conventions ? Project-specific conventions to follow when writing code Somewhere under http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/code
Using Sun Products ? Deploying and debugging the registry on the Sun Java System Web Server Merge into http://ebxmlrr.sourceforge.net/wiki/index.php?title=Deploy/container/SunAppServers
Maven and site docs http://ebxmlrr.sourceforge.net/wiki/index.php/Dev/omar/process/maven
Retrieved from "http://ebxmlrr.sourceforge.net/wiki/index.php/MetaWiki"