June 14, 2005uPortal Summer Conference, Baltimore, MD

John Fereira, Cornell University

Andrew Petro, Yale University

uPortal Documentation Roadmap

June 14, 2005uPortal Summer Conference, Baltimore, MD

Overview

• Official web site

• JA-SIG Wiki

• Mailing lists

• Jira Issue Tracking system

• Future of uPortal Documentation

• How you can contribute

June 14, 2005uPortal Summer Conference, Baltimore, MD

Official uPortal Website

• URL: http://www.uportal.org

• See also: http://www.ja-sig.org

• demo

June 14, 2005uPortal Summer Conference, Baltimore, MD

uPortal Wiki

• URL: http://jasigch.princeton.edu:9000

• Open to anyone

• Spaces• JA-SIG

• uPortal

• uPortal Channels

• Portlets

• Central Authentication Service

• Integrated with Issue Tracking System

• Demo

June 14, 2005uPortal Summer Conference, Baltimore, MD

uPortal Mailing Lists

• jasig-announce@unm.edu– Low traffic– Open membership– uPortal releases, conferences, training classes– Archive: https://list.unm.edu/cgi-bin/wa?A0=jasig-announce

• jasig-portal@unm.edu– High traffic– Open membership– Discuss anything related to uPortal– Archive: https://list.unm.edu/cgi-bin/wa?A0=jasig-portal

• jasig-dev@unm.edu– Medium traffic– Membership restricted to uPortal framework developers– Coordination of development work– Archive: https://list.unm.edu/cgi-bin/wa?A0=jasig-dev

June 14, 2005uPortal Summer Conference, Baltimore, MD

Future of uPortal Documentation

• Documentation in xml (Anakia)• http://jasigch.princeton.edu/uportaltest/index.html

June 14, 2005uPortal Summer Conference, Baltimore, MD

uPortal Issue Tracking System

• http://jasigch.princeton.edu:9000/jira

June 14, 2005uPortal Summer Conference, Baltimore, MD

What is JIRA?

• Commercial product free to our open-source project

• Java web application hosted on Clearinghouse machine

• Successor to our Bugzilla

June 14, 2005uPortal Summer Conference, Baltimore, MD

Issues are a superset of Bugs

Bugs New Features

Improvements Tasks

June 14, 2005uPortal Summer Conference, Baltimore, MD

Documenting Known Issues

June 14, 2005uPortal Summer Conference, Baltimore, MD

Change Logs / Release Notes

June 14, 2005uPortal Summer Conference, Baltimore, MD

Planning future releases

June 14, 2005uPortal Summer Conference, Baltimore, MD

Understanding Risk / Obstacles

June 14, 2005uPortal Summer Conference, Baltimore, MD

Assignees

• Developers take issues, becoming Assignees.

• Assignees are responsible for resolving the issue.

• They “start progress” on an issue to indicate actively working on it.

• Once they think it’s resolved, they mark it resolved.

June 14, 2005uPortal Summer Conference, Baltimore, MD

Submitting an issue

June 14, 2005uPortal Summer Conference, Baltimore, MD

Select project and issue type

June 14, 2005uPortal Summer Conference, Baltimore, MD

Summarize, Categorize

June 14, 2005uPortal Summer Conference, Baltimore, MD

Describe

June 14, 2005uPortal Summer Conference, Baltimore, MD

Reporters have an important role

June 14, 2005uPortal Summer Conference, Baltimore, MD

Comment

June 14, 2005uPortal Summer Conference, Baltimore, MD

CVS Integration and patching

June 14, 2005uPortal Summer Conference, Baltimore, MD

Speaking of Patches

June 14, 2005uPortal Summer Conference, Baltimore, MD

Vote?

June 14, 2005uPortal Summer Conference, Baltimore, MD

Help track issues

• Our issue tracking and reporting is only as good as its data

• You can help by reporting issues– Keeping “affects version” metadata correct– Drawing attention to important issues we’re

overlooking– Commenting, adding your insight– Posting patches

June 14, 2005uPortal Summer Conference, Baltimore, MD

Contribute to the Wiki

June 14, 2005uPortal Summer Conference, Baltimore, MD

Perhaps start with…

June 14, 2005uPortal Summer Conference, Baltimore, MD

Even if you’re not ready to edit…

• Wikis are all about collaborative editing

• There’s built in versioning and rollback

• So please feel welcome to edit

• But you can also post comments

June 14, 2005uPortal Summer Conference, Baltimore, MD

Contribute to the static website

• Notice something outdated, something to fix, something confusing?– Open an issue– Post a patch– Committer? Edit the CVS. Instant

gratification.

– uPortal documentation has an issue tracking space in JIRA.

June 14, 2005uPortal Summer Conference, Baltimore, MD

Help on the mailing lists

• We aspire to be– Friendly– Welcoming– Mutually supportive

• You have experiences, answers to share

June 14, 2005uPortal Summer Conference, Baltimore, MD

Help Harvest from the Lists

Email:Pros:Threaded discussionFreeformFlexible

Cons:Becomes “stale” very quicklyNot easily updateable, editableScrolls off the top of our inboxes to be forgotten

Tracking concrete issue tokens

Capture the “final answer” – and ableto update when the final answer Changes.

June 14, 2005uPortal Summer Conference, Baltimore, MD

Speakers: John Fereira and Andrew Petro

Track: New Concepts

Presentation Title: uPortal Documentation Roadmap

Date: 06/14/2005

Time: 2:00 PM – 3:00 PM

Speaker Evaluation Info:

The End

Questions ?