Documentation Notes
This document's purpose is to outline a structure for documentation about the Open Media System.
This documentation will follow the Drupal Editorial Style Guide
The original contributors to this outline structure are Stefan Wray, Ann Theis, and John Montgomery.
First draft created on March 21, 2009.
Project Documentation
This is general documentation about the Open Media System:
- Mission and Vision
The Open Media System is the development and distribution of an open-source tool set that will enable local Public Access TV stations and Community Media organizations to collaborate as a user-driven, locally-focused alternative media network targeted at under-served communities.Based in Drupal, the project is developing a modular, web-based system that puts the community in the driver's seat and makes the media they produce more accessible locally and nation-wide through digital distribution. Leveraging thousands of open-source contributors, the tools are relatively easy and affordable to implement, transforming any CTC or Access center into a user-driven, Net2.0 portal for their community.
- Background and History (from Knight Grant Language - Need from Tony)
- OM sites - Partners and contributors
- Open Media System Architecture (site specific DOM workflow)
- Open Media System Network (connected sites and national architecture)
- System Requirements
- Technology
- Human resources
- Community support
- Financial
Developer Documentation
This is documentation for Drupal developers:
- OM Specific Drupal Development
- Open Media Support (module)
- TVframe (theme)
- Open Media Broadcast Synchronization (module)
- OM_Show (Drupal module)
- OM_Timeslot (Drupal module)
- Other Drupal modules in development
- Additional Required Drupal Modules
Implementation Documentation
This is documentation for installation and configuration:
- System requirements
- Recommended Drupal modules
- Open Media System Installation and Configuration Guidelines
- Open Media Support
- How to install and configure the Open Media Support module
- TVframe
- How to install and configure the TVframe theme, including Zen module
- Details about the Zen module and sub-sub-theme
- Projects (Organic Groups)
- How to install and configure Organic Groups
- How the Open Media System is using Organic groups for Projects
- MERCI
- How to install and configure MERCI
- How to customize MERCI for specific needs
- Show
- How to install and configure the Create Show feature
- Broadcast Sync
- Background information on different playback servers
- Telvue's Princeton servers
- Leightronix's Nexus servers
- Synergy Broadcast System servers
- How to establish a standard RSS structure in different playback server environments
- Details on Airings, Broadcast cast sync, Broadcast server schedule feed
- Background information on different playback servers
- Timeslot
- How to install and configure Timeslot
- How does Drupal interfaced with playback servers.
- Events (classes)
- How to install CiviCRM (link to standard CiviCRM documentation)
- How to configure CiviCRM's Event feature for class registration
- How to establish rules for class certifications and prerequisites
- How to set up PayPal for online transactions
- Open Media Support
User Documentation
This is documentation for Open Media System users.
- Administrative Users
- Projects (Organic Groups)
- How to set up Content types
- Explanation of Project Wiki, Project Blog, Project Event
- MERCI
- How to manage reservations (view, change status, edit, delete)
- How to set up checkoutable inventory (create content types, create content, create taxonomy)
- How to set permissions for checkoutable inventory
- CiviGroup Role Sync
- Add Roles and Sync privileges with CiviCRM
- Project
- How to Merge Duplicate Projects
- Shows
- How to change author/project
- Timeslots/Themes
- Creating Timeslot Themes
- Creating Timeslot Events
- Managing Timeslot Events
- Classes and Groups (CiviCRM & CiviEvent)
- How to enter new classes in CiviCRM's Events
- How to create Groups
- How to create Smart Groups
- How to "certify" members using groups
- Projects (Organic Groups)
- Member Users
- Projects (Organic Groups)
- How to create projects
- Project Blog
- Project Wiki
- Project Event
- How to add/manage members
- Project Tools
- How to merge projects
- MERCI: Equipment Reservations
- How to create reservations using MERCI's my reservations
- How to view/edit/delete reservations
- Show
- How to create a show
- How to manage a show
- Timeslot
- How to get a series show
- Events (classes)
- How to sign up and register for classes
- How to create projects
- Public Users
- How to vote and leave comments
Comments
Status of documentation?
Just curious to the status of OMP documentation. Is this the current outline or is it evolving elsewhere? Will this be just text or a combination of screencasts and other materials? Finally - do you have enough resources on this effort or do you need help?
Gus Austin
Yea! Wikis on GDO now allow
Yea! Wikis on GDO now allow comments! No need for wikis on openmediaproject.org
I'm not sure what you are looking at, but the new structure is here...
http://www.openmediaproject.org/handbooks/open-media
Equipment Checkout is by far the most complete. Despite good intentions from the project partners and several people here in Denver being tasked with writing documentation as part of their job, the documentation is far from the point that someone who downloads the Open Media Install Profile would be able to use it.
I don't enjoy writing documentation, but I've tried to at least bang out a draft of the information I have in my head. What I really hate most about documentation is every minute I spend writing it is less time I spend on the code. Obviously the project can't be adopted by non-developers without documentation, but with so few developer resources available it is frustrating that we can't get more support writing and revising the documentation from groups interested in using the modules we've developed.