Version 19

    Introduction

     

    JBoss Labs Projects are community-based open source projects.  Each project has a project lead and a set of core developers.  The project lead is a responsible for the overall direction of the project including, the road map, goals, tasks, bugs, and release management.  The core developers are delegated tasks from the project lead and are responsible, along with the lead, for the primary development efforts of the project.

     

    Each project has a set of committers.  These committers may or may not be developers, as some may contribute documentation or project content.  For an open source project to be successful, it must have a vibrant set of community committers and contributors.  Contributors can be anyone who submits any code or content to a project, and they are always welcome.

     

    Each project has available to it

    a set of components which can be utilized to promote and manage an open source project:

     

    1. A Subversion Repository

    2. A Wiki

    3. A Blog

    4. Any number of Freezone pages

    5. A JIRA Project

    6. One or More Forums

     

    A New JBoss Labs Project

     

    If you and your project has been chosen to be a JBoss or JBoss Labs project, there are a few simple steps required to create your project on the JBoss Labs Infrastructure:

     

    1. Identify all contributors and committers for your project by collecting their jboss.com login IDs.  These IDs will be used when granting access to the content managment repository and to the Subversion source code repository.

    2. Identify and locate all the URLs for any existing project specific sites or components such as:  JIRA project, Wiki pages, Documentation, Downloads, and Blogs.

    3. If your project has a logo, get a medium-sized version of it handy to place in the JBoss Labs content repository as you will need it.

    4. If you don't already have one, write up a project description, in HTML.  This description should include: 

      • A detailed description of what your project is all about.

      • A section describing the community around your project, including:

        1. A list of current contributors

        2. Any project affiliations

      • A description of the license(s) for the open source project.

      • A List of the primary features that shine in your project.

      • A categorization of your project (i.e., it's a web server, a content management system, etc.)

      • A list of the JEMS products that this project integrates with.

     

    Once you have gathered up the list above, you need to start to populate your JBoss Labs project.  If you haven't received a notification that your project has been created on JBoss Labs, then you need to contact the JBoss Labs Team, see Contacting JBoss Labs

     

    Your Subversion CMS Repository

     

    Once your project has been created, you will receive an URL for the location of your project's CMS repository.  This will look something like:

     

    https://cms.labs.jboss.com/prod/forge/portal-content/default/members/mysuperproject

     

    You will need to use any Subversion client to check out this repository location.  Once checked out, you will modify the files contained in your working copy to make changes to your project.

     

    This location will contain your project.xml file.  This file is really the primary descriptor of your project.  For a detailed explanation of what the structure and purpose of the project.xml file, see this wiki page.

     

    In this project.xml you define the components you want to display in your project

     

    Your Project's Wiki Page

     

    All projects on Labs start with a default wiki page that is the name of the 'key' of their project.  For example, the JBoss Eclipse IDE project on Labs has a key of 'jbosside'.  This means that if you go to the url http://labs.jboss.com/wiki/Jbosside you will find the base wiki page for JBoss Eclipse IDE.  NOTE:  The first letter must be capitalized.

     

    All wiki pages on JBoss Labs require that you be logged in before you can edit them.

     

    We've found that open source projects' wiki pages are critical to their success.  They need to have detailed information and as much of it as possible.  In fact all of your documentation for your project should probably start as wiki pages as they are a snap to write and allows the world to contribute directly and immediately.

     

    Your Project's Blog

     

    Each project has a blog.  Adding a new blog entry is as simple as saving a text or html file in your PROJECT_HOME/blog dir in your working copy of your project's Subversion CMS repository.  Each project has a blog dir already created for them.

     

    So, to create a new entry, create a new file.  You can put any html markup you like in that file. You also have to set the title of the entry by setting the title property of the file (that is an svn-property).  Once you save and commit the file to the repository (i.e., svn ci mynewblogentry.html ), your blog entry will be visible in a few seconds on the JBoss Labs website.  We don't moderate blogs, but if we find any substantial nastyness, we will remove or edit the entry.

     

    Freezone Pages

     

    Freezones on JBoss Labs are simply free-form html pages.  You have a directory in your project's directory, which is your working copy checked out from Subversion, called freezone.  In that directory you can place any html that uses relative links to that directory.  So, for example, if you already had a set of documentation that was generated using the Apache xdocs project, you could create a directory under the freezone/ dir, say call it freezone/mydocs,  and just copy the html and images into that directory.  Then, you can add a link to that html by modifying your project.xml file for your project.

     

    For the details of how to do this, see ProjectFreezone