This page describes forum processes (and resources for supporting them).

Table Of Contents:

Forum Resources

The areas of the forum available for public use are this wiki and the celinux-dev mailing list.

Some private resources of the forum, such as internal mailing lists, the private wiki, and internal web sites, are described at: MemberResourcesAndProceduresOverview (Sorry, but this page is available only to members, and is password protected.) This page also describes startup procedures for a new member of the forum (joining WGs, etc.)

Web Sites

There are two CE Linux Forum web sites:

The main web site is where people get their first introduction to the forum. It has sub-sections explaining the purpose, membership, and structure of the forum. At the main CELF web site, new companies may apply for membership, and employees of member companies may register to begin their activity in the forum.

The tree web site hosts the online resources for the technical work of the forum. This includes download areas, mailing lists, and wikis (explained later).

Mailing list

The public technical mailing list of the forum is celinux-dev. It is provided using the mailman mail list system. This list is for e-mail discussions between all parties interested in using Linux in consumer electronics devices (both members and non-forum members of the forum), and is open to the public.

Patches submitted to the forum should be submitted to the celinux-dev mailing list. If a patch is submitted to an open source project as part of forum work, then the celinux-dev mailing list should be copied. This helps everyone to track what is going on with the various projects that the forum is involved with.

The celinux-dev mailing list is at:

Wikis

A Wiki is a web collaboration system. CELF maintains separate private (members-only) and public wikis. This page you are reading is a page in the CELF public wiki.

The public wiki is used to hold information that can be seen by the public. Public wiki information includes patches and descriptive information about them, information about technology the forum is working on, links to related projects, and anything else presented to the public or helpful for advancing CELF or CELF-related open source projects.

Anyone can edit pages in the public wiki, using a normal web browser. Wiki pages are written using a very simple markup language, which is explained in the wiki Help pages.

Procedures

This section explains some tasks central to interacting with others in the forum, including where and how to do them.

General Wiki Usage

For a basic explanation of how wikis work and the philosophy behind them, see HelpMiscellaneous/FrequentlyAskedQuestions (for help with finding named pages, see the "SiteNavigation" button at the top of the page).

Here are some specific tasks you may wish to do on the wiki:

Editing a wiki page

Click on the EditText link at the bottom of the page. The source wiki text is displayed in a web form, with a "cheatsheet" for some aspects of the wiki simplified markup language shown at the bottom of the page. In order to discourage malicious edits, you must be logged into a user account before you can edit a page. To create an account or log in, click on the UserPreferences link in the upper right corner of the page. (This is free and easy, and does NOT require personal information, although you can provide an e-mail address if you wish to subscribe to pages). See HelpForBeginners and HelpOnEditing for more information on editing a page.

Printing a wiki page
To print a page, click on the print icon on the wiki page. This removes the wiki decorations (title, navigation bar, link trail, etc.). Then select "Print" in your browser. If you try to print a page without clicking on the print icon, you usually end up with an empty page at the printer.
Looking at prior versions of a wiki page
Click on the info icon, and then click on the version of the page you wish to examine.
Creating a new wiki page

See HelpOnPageCreation

Subscribing to a wiki page

There are two ways to subscribe to a wiki page, and receive e-mail notification of all edits to that page. To use either way, you need to have created an account on the wiki. (To do this, click on the link to UserPreferences and fill out the information on that page). The first way is to click on the subscribe (envelope) icon on the page itself, and the second way is to add the page name (or a regular expression which matches the page name) to your list of subscribed pages on your user preferences page. To subscribe to all pages in the wiki, use the regular expression ".*".

General mailing list usage

All members and parties interested in CELF technical activities should subscribe to the celinux-dev mailing list. This can be done at the celinux-dev subscription page.

Here are some things you can do with the archive:

Setting subscription options
Once you have subscribed to the list, you can control aspects of your subscription by visiting the subscription page.
Browse messages

Go to the celinux-dev list archives

Searching for messages
Use Google (or some other web search engine) to search the archives for topics of interest. Just use "celinux-dev" as one word in your search query.

Forum Processes

Wiki and Mailing List Overview

The following diagram shows the structure of the wiki pages usually associated with forum technical activities. This shows the relationship between forum wiki pages, mailing lists (both forum-managed and open source), open source projects (web sites, repositories, etc.), and the forum PatchArchive.

Overview of wiki structure

WGStructure4.png

Workgroup participation

Each Working Group is lead by a Chair who administers the group and arranges the logistics of WG activity. Different WGs in the forum have different objectives (such as information gathering, technology development, or architecture and requirements definition.)

To participate in a working group, join the appropriate private e-mail list for that group. Also, participate in the arranged conference calls, and attend the arranged face-to-face meetings.

Please be willing to accept assignments from the Working Group Chair, to further the efforts of the group.

Chairing a WG

See the ChairHandbook page for more detailed instructions if you are the Chair of a forum Working Group.

Core Groups

Each WG maintains a list of "core group" members, who have voting rights in the event a vote is required on some topic. It is important for the Chair to be able to identify the real participants of the group, as opposed to those just "lurking". Please identify to the Chair of the WG if you plan to participate in a meaningful way in a working group.

Working Group Tiers

There are 3 tiers of forum technical groups, which are referred to here as:

  1. ad hoc group
  2. special interest group
  3. formal working group

There are basic differences between these types of groups, depending on the scope of operation (single or multi-project), formality of Steering committee approval, expected use of forum infrastructure, etc.

The basic differences are these:

Here's a table summarizing these differences:

WG Style

Wiki usage

Mail List usage

Leader

SC approval

ad hoc

single public page (likely)

OSS list or celinux-dev

self-appointed

no

special interest group

WG pages + project pages

CELF WG list, and OSS list(s) or celinux-dev

group-appointed

no

formal working group

WG pages + project pages

CELF WG list, and OSS list(s) or celinux-dev

SC appointed

yes

Creating WG resources (wiki pages and mailing lists)

ad hoc group

To create an "ad hoc" group, just do the following:

special interest group

For a SIG, please create at least 3 pages on the wikis:

For each technology area discussed by the group, please create a page on the public wiki (using the TechnologyProjectTemplate page), and link to them from both the private WG page and the public WG page.

To create the forum mailing list for your special interest group, please ask the executive director of the forum (Thomas Swidler), to create the list. After this is done, send mail to the MEMBERS mailing list, announcing the new list and asking for parties interested in this special interest group to join that list. Also, put a reference to the mailing list archives page on your WG home page in the private wiki.

formal working group

WG Creation

To create a formal working group, you need to make a formal proposal to the CELF Steering Committee. This requires a bit more overhead and time, but is necessary if you want the approval of the Steering Committee for the output of your group.

Please contact the Architecture Group Chair (Tim Bird) for detailed instructions on making such a proposal, and some sample presentations which have been used in the past.

WG resources

Each formal working group should have an administrative page on the private wiki (linked to from the private FrontPage), and a "resources" page on the public wiki (linked to from the public FrontPage. These should be initially set up by the Working Group Chair

Also, each formal WG should have a private e-mail list, with archives.

See the ChairHandbook page for instructions if you are the Chair of a forum Working Group.

Submitting a patch

Patches may be submitted to the forum in a number of ways:

  1. by e-mail to the celinux-dev mailing list
  2. by sending to the celinux-dev mailing list a copy of a patch submitted by e-mail to an external open source project or mailing list
  3. by attaching (uploading) the patch to a wiki project or technology page
  4. by adding the patch to the main PatchArchive page

    • this is done by attaching (uploading) the patch to the page, and editing the table on the page to add a description of the patch and reference to the attachment.
  5. by e-mail to a CELF working group (for forum members)

In all cases you should follow the guidelines at: PatchSubmissionHowto

In general, the different methods of providing a patch will be used at different times in a patch's life-cycle. Patches under development and review will normally be submitted via e-mail, to facilitate interaction, while more finalized versions would be attached to wiki pages and inserted in the PatchArchive as they are completed.

Most patches should be submitted using methods 1 through 4 (in the open), so that maximum participation with the open source community can be achieved.

Method number 5 should only be used in rare cases. Patches should be submitted to only the WG when the patch is not mature and when there is no existing open source project or interested set of non-member developers, for the technology. Alternatively, a patch may be submitted to only the WG as part of discussions which are desired to be closed within the forum, for example for legal reasons.

It is perfectly legitimate, in most cases, to submit technology (i.e. patches) directly to the appropriate open source project, rather than to the forum. This would technically be work outside the scope of forum activity. However, as noted in case number 2 above, please notify other forum members when this occurs so that we can more easily benefit from your work. Due to the large number of different projects, and large volume of e-mail on many different lists, it is very likely that most of us will miss your posting. If you notify us, it is much more likely that someone from the forum may be able to assist with testing or promoting your work.

Patch Archive

The patch archive page is the central repository where the forum publishes implementations for use by our member companies and the community.

/!\ ANYONE can add a patch to this page if they would like to.

Patches should follow the format described in the PatchSubmissionHowto. They can be uploaded to the page using the AttachFile link at the bottom of the page. When attaching a patch to the page, please make sure the patch name has no spaces (there is currently a bug with attaching files with spaces in their names). Put a link to the attached file in the current patch table. Also, please provide information about the status of the patch, and a link to a related technology page.

Main Project List

The forum maintains a single consolidated list of projects at ProjectList. This is the main list of projects that forum members are working on or are interested in.

/!\ Please note that the listing of a project in the project list is NOT an indication of forum commitment to or endorsement of the project. Nor is it an indication that any particular member company of CELF will commit resources or effort to that project.

Other stuff still needing descriptions?

ForumProcesses (last edited 2008-05-07 18:22:20 by localhost)