OpenSolaris

You are not signed in. Sign in or register.

Community and project lead site reference

Everytime we use the term "community" on this page, we mean "community or project". If we expanded all the substitutions, then the page's tediosity skyrockets.

How to manage your community

If you are the leader of a community, you should see your user name and your "real name" on your community's "View the leaders for this community" page (linked at the top of your community's main page).

As a community leader you should be able to:

  • Add a new community leader: You can add any other registered member in the system as community leader, using their User ID. Community leaders are subject to the Terms of Use.
  • Add a page: You can add as many pages as you want to your community. You also have the ability to nest pages. All of the pages that you create will show up as navigation items in your community navigation box.
  • Show a hidden page: You can display a page that has been hidden.
  • Hide or delete a page: You can can create pages in hidden mode to make sure that you have them laid out correctly, and then turn then on later. You can also delete pages.
  • Remove/re-order the navigation links: You can remove and re-order the navigation links within your community.
  • Manage and use attachments: You can upload attachments (not all file formats are currently supported) to a page and reference them using HTML or TML (Tonic Markup Language).
  • Add a blog: You can add a blog.
  • Issue an announcement: You can make a community-wide announcement; a feed is provided for your community participants to watch for announcements.
  • Endorse a project: You can endorse a project.
  • Add a Page of Core/Contributors: You can make page that auto-generate a list of your communities Core/Contributors from the database.
  • How To Add a Repository: You can add a Repository to your project.
  • How To Manage Committers: You can add/remove commit rights to a project.
  • How To handle missing Discussions pages: If you get the "This project does not have any discussions yet." message.

Note: TML versus HTML: We have created a wiki-like markup language called TML (Tonic Markup Language) to use in page creation, for users that prefer not to use HTML. HTML is also available for users that want to do more advanced layout and design. Within community, a community leader can put any valid HTML into a page, hence the need to carefully limit those you select as community leaders.

How to manage your project

To get started, read and follow the directions on the Project Set-up page. Then continue with the information outlined below.

In addition to the basic operations for communities above, projects also have support for managing source code repositories. There are site-specific user instructions for Mercurial and Subversion, courtesy of the Tools community.

It is the responsibility of project Leaders to confirm that contributions to the project are coming either from community members who are Sun employees or who have a Sun Contributor Agreement on file.

When project teams take contributions of whole pieces of technology (for example, a device driver) via Sun Contributor Agreement, the team should confirm with the contributor that he/she wrote all of the code. If third-party code was used, other approvals are required.

As a project leader you should be able to:

It's worth noting that the opensolaris.org infrastructure automatically publishes a repository's contents at a publically available URL, if anonymous checkouts are permitted for that repository. The URL is based on the project and repository name and follows the pattern 

http://opensolaris.org/sc/src/[project]/[repository]/...
This mechanism may be a useful alternative for projects wishing to publish dozens or hundreds of files, or to publish automatically.

Instructions

How To Add A Community Leader
  • On the community home page in the section "The leaders for this community" select the [Edit Leaders] link
  • Enter in the usernames of the people you want to add as community leaders. One per line.
  • Click [Save].

How To Add A Page
  • Click the add page link under the Community Editor Navigation.
  • Enter the short name for the page. This will be used to create the page URL.
  • Enter the Title. This will be the name of the page and the name of the navigation link.
  • Choose your content type, HTML or TML. For assistance on using TML, click the [Tonic Markup] link below the Content box.
  • Enter your content in either HTML or TML.
  • Select the parent page. This selection will dictate where your new new page is located in the community. The default is Home, which means all pages that are added are siblings. Whatever page you are on when you click "add page" is treated as the sibling.
  • Selected [yes] or [no] to "create hidden". This allows you to create a page that users can't access.
  • [Preview] will display the page layout along with an edit box.
  • [Save] will create the page

How To Show A Hidden Page
  • From the community home page, click the "Manage Children" link on the Community Editor navigation.
  • You should see table of Visible Pages and a table of Hidden Pages.
  • In the table of Hidden Pages, select the file you want to show and click [Edit].
  • On the ensuing Edit page, under Edit Page Status, click [Show].
  • The page will refresh with the Edit Page Status, reading [Hide].

How To Hide And Delete A Page
  • Go to the page you want to hide and select [Edit This Page].
  • Under the Edit Page Status section, click the [Hide] link.
  • The page will refresh with the Edit Page Status, reading [Show] and [Delete].
  • To delete the page, click the [Delete] link.
  • You will get confirmation screen, hit [yes] and the page has been deleted.

How To Re-Order Links
  • On the community home page, click the Manage Children link.
  • You should see table of Visible Pages and a table of Hidden Pages.
  • Select the display order that you want the navigation items (pages) to appear in the community.
  • Hit [Save].

How To Manage Attachments
  • On the community home page click the Manage Attachments link.
  • Click on the "Add files" link on the Manage Attachments page.
  • Use the [Browse...] button to navigate to the files you wish to upload and enter in a description.
  • Hit [Save].
  • You are brought back to the Manage Attachments page with your attachment now available.
  • To delete the attachment click the [Delete] link.

How To Use Attachments

  • Once you have successfully uploaded your attachment it will be available for that page. Plead note, attachments are page specific, you are not uploading it for the entire community, as result you can always point to an attachment directly by name, as in the example below.
  • For an attachment with filename, test.png, you would include either 
    <img src="test.png" alt="Alt Text" width="120" height="100">
    for an HTML page, or 
    ![alt text](test.png)
    for a page using TML for markup.

How To Add A Blog
  • On your left hand community navigation click the [Blogs] link
  • The Community Editor navigation should now have a new set of links called [Manage Blog Feeds] and [Find Blog Entries]
  • Click [Manage Blog Feeds]
  • Click the the [Add Feed] link
  • Enter in a valid syndication feed in the text field. The system accepts RSS 1.0/2.0 and ATOM. An example feed (from blogs.sun.com) would be: 
    http://blogs.sun.com/roller/rss/jimgris
  • Hit [Add]
  • You are brought back to Feed Information page showing that you were successful

How To Add An Announcement
  • On your left hand community navigation click the [Announcements] link
  • The Community Editor navigation should now have a new set of links called [Find announcements] and [Add announcement].
  • Click [Add announcement].
  • Enter the announcement title, date, and content in the appropriate fields. You may choose to leave the announcement hidden until your fellow leads have reviewed it. Set the radio button under "Create Hidden?" appropriately.
  • Hit [Save]
  • You will be directed to a page that indicates that the response was successful (unless something failed, of course.)
  • Your community's announcement feed is available as 
    http://www.opensolaris.org/rss/os/community/[community_name]/announcements/rss2.xml
    or 
    http://www.opensolaris.org/rss/os/project/[project_name]/announcements/rss2.xml
  • You can also edit and delete existing announcements. Use the "Find announcements" link to search through your community's announcements.

    • opensolaris-announce is the main list for announcements to the entire community globally. Here's how Communities, Projects, and User Groups can use this list:

  • Sign up to opensolaris-announce 
    • http://mail.opensolaris.org/mailman/listinfo/opensolaris-announce.
  • Look at some examples of announcements to get an idea about generally accepted formats
    •  http://opensolaris.org/jive/forum.jspa?forumID=76.
  • Post your announcement to opensolaris-announce from the Jive forum or from your email client, but please don't cross-post to other lists on the same mail. Also, opensolaris-announce is a one-way moderated list, so after you post you will get a bounce notification saying your mail is in a queue. Moderators only filter spam, so if your announcement is directly related to OpenSolaris it will most likely be approved within a few hours.

How To Endorse A Project

This operation is only available to Community Leaders.

  • On your left hand community navigation, click the [Endorse Projects] link.
  • A checklist of the available OpenSolaris will be displayed.
  • Click the checkboxes to select or deselect the projects you wish to endorse or deendorse.
  • Hit [Save].
  • Your browser should display a listing of the endorsed projects for your community.

How To Add a Page of Core/Contributors

This operation is only available to Community Leaders.

myCommunity      Formal name of community
===========      ========================
advocacy	 Advocacy Community Group
approachability	 Approachability
arc		 Architecture Process and Tools
brandz		 BrandZ
desktop		 Desktop
device_drivers	 Device Drivers
documentation	 Documentation
dtrace		 DTrace
edu		 Academic and Research
fm		 Fault Management
ha-clusters	 HA Clusters
install		 Installation and Packaging
int_localization Internationalization and Localization
laptop		 Laptop
ldoms		 Logical Domains
mdb		 Modular Debugger (MDB)
networking	 Networking
nfs		 NFS
ogb		 OpenSolaris Governing Board (OGB)
on		 OS/Net (ON)
performance	 Performance
power_pc	 PowerPC
printing	 OpenSolaris Printing
security	 Security
smf		 Service Management Facility (smf(5))
storage		 Storage
sysadmin	 Systems Administration Community Group
testing		 Testing
tools		 Tools
x_win		 X Window System
xen		 Xen
zfs		 ZFS
zones		 Zones

How To Add a Repository

This operation is only available to Project Leaders.

  • Above the project's main page, click the [SCM Managment] link.
  • Click the [Add Repository] link on the left hand menu.
  • Fill in the fields as you see fit. If you wish a separate alias for commit notifications, make a request on website-discuss.
  • If you wish to disallow checkouts by anonymous users, leave the "Anonymous" checkbox unselected.
  • Hit [Add].
  • Your browser should display a listing of the repositories for your project.

To initialize a Mercurial repository, create a local clone of the empty repo that you just created. Initialize the local clone (e.g., pull from ssh://anon@hg.opensolaris.org/hg/onnv/onnv-gate), then push to the new repo.

You might also want to review Dan Price's hints for setting up a repository.

How To Manage Committers

This operation is only available to Project Leaders.

  • Above the project's main page, click the [SCM Managment] link.
  • On the left hand menu, click the [Find Repository] link. Select the repository by clicking on its name.
  • On the left hand menu, click the [Manage Committers] link. A list of the project leaders and a list of the affiliates will be displayed.
  • Adjust the committers' checkboxes to set rights appropriately. To be granted committer status, a user must be registered with the site and be an affiliate of your project.
  • Hit [Submit].
  • Your browser should redisplay the updated leads and affiliates list for your community.

How To handle missing Discussions pages

This operation is only available to Project Leaders.

Note: This procedure also applies to you if you are trying to get rid of a Jive forum that shows up automatically in the "Discussions Lists" table at the bottom of the "Discussions" child page.

When setting up the Discussions "child" page, there's a work-around required that is related to the fact that the Mailman system and the website software are not tightly integrated. The symptom is that the following text shows up at the bottom of the Discussions page:

"This project does not have any discussions yet."

To correct this, hide the Discussions child page (deleting it, effectively).

Then create a custom "child" page called mailing-lists, which will show up in the sidebar effectively replacing `Discussions' link that you just hid. Create a link to your mailing-list homepage in the new child page.

Alternatively, you can just link to the mailing list somewhere in the body of your main page. Or you can do both.

All project pages should clearly identify and provide a link to where project discussions take place.