 |
Setting java.net projects for OSS/J JSRs
For each JSR related to an OSS/J API the spec leader will create two java.net projects under the java.net JSR Community:
- A public project, jsr<3-digit JSR number>-public, where the spec leader will put all the public information he/she and the Expert Group would like to share with the public. This project can be a click through (licenced) project. It is recommended to use a read only type of project. The java.net project creation requirements are listed in the project_requirements page.
- A private project, jsr<3-digit JSR number>-private, with CVS where the spec leader and the expert group will manage the on-going work. The structure of this environment is described here.
Here you find guidelines on how to create the project pages.
Warning: public and private projects have to be created at the same time.
Creating the public project
In the Project creation page use the following attributes:
- Page 1/2
- project name: jsr<3-digit JSR number>-public
- project description: use the description from the JCP page of your JSR, example at: http://jcp.org/en/jsr/detail?id=144
- topic related to your project: select JSR and J2EE? (minimum)
- Services: check CVS, Issue tracking, File sharing, News Posting
- Page 2/2
- license: use other, the license terms are common to all JSR in the OSSJ initiative. A pointer to the www.ossj.org will be added later (Note: need additional info here)
- check the box use index.html
- Artifact code: use the three letters already defined in the "group" field in Document Naming Convention
Once created, complete the index.html front page (using https://jsr144-public.dev.java.net/ as example).
The front page shall contain the following text about license terms:
The components of this projects are regulated by the OSS/J Harmonized License Model (Apache 2.0 based):
- License for the Specification components [link to the HLM Specification license text file]
- License for the implementation components including source code [link to the HLM reference implementation source code license text file]
- License for the test suite components including source code [link to the HLM TCK source code license text file]
- License for the test suite components including binary only [link to the HLM TCK bin license text file]
Downloading/ Using these components implies having accepted the terms of the licenses listed above.
Creating the private project
In the Project creation page use the following attributes:
- Page 1/2
- project name: jsr<3-digit JSR number>-private
- project description: "Project contains the work in progress material needed to share information between Expert Group members and/or OSS through java Initiative members."
- topic related to your project: select JSR and J2EE? (minimum)
- Services: check CVS, Issue tracking, File sharing, wiki
- Page 2/2
- license: use other, the license terms are common to all JSR in the OSSJ initiative. A pointer to the www.ossj.org will be added later (Note: need additional info here)
- check the box use index.html
- Artifact code: use the three letters already defined in the "group" field in Document Naming Convention
Once created, complete the index.html front page (using https://jsr144-private.dev.java.net/ as example).
The private project is dedicated to Expert Group (as listed in the JCP private area of the JSR) and OSS/J members.
Setting users' roles
Once the projets have been approved, the spec leader needs to grant access to the users of the project by setting the users' roles: on the left pane menu of the project home page:
- ask the Expert group to send their java.net user ID and let the OSSJ product know in case some members would like to stay informed about the JSR.
- click on "Membership" and then "Add new member/role"
- in "Mass add" specify the java.net user ID(s)
- in "Grant these roles to all designated users": select the role(s) to assign to the user(s) specificed above
- check "Done granting roles"
- click on "Grant roles"
You have a description of the available roles here.
For the private project, possible roles are Observer, Developer or Content Developer.
For the public project, possible roles are Developer or Content Developer.
Create base CVS directory structure for the source code under the private project
By default the CVS will be populated with the default "www/index.html" from the CVS root of the project. The "www" directory shall be used to create any web page related to your project.
- For the development environment, a "workspace" directory shall be created at the same level as "www".
- Then a new directory per version of your JSR shall also be created. This will ease the future maintenance effort on a specific version(s) when needed.
- The directory naming convention is <api name>-x_y/workspace (for example common-1_3/workspace).
- Finally create the "spec, "ri" and "tck" folders.
The content of these folders will depend on the choosen development environment.
But, the recommended directory structure for spec or RI or TCK environment can be found here.
Get project statistics
java.net records access to your project as an Apache log file. This service allows project owners to receive those raw log files. In addition, you can also see a summary of the www access for your project in a simple stats report. When your project signs up for this service, owner@YOURPROJECT.dev.java.net receives a periodic e-mail which contains the gzip-compressed log file and/or stats reports for the last period.
Detailed settings Information.
(need improvement) Migrate existing ossj and tck-ossj jsr branch into new public and private java.net project
If the JSR already have a branch in ossj and/or tck-ossj projects, the spec leader will have to migrate the content from these two projects to the new JSR specific public and private projects. Since the recommended directory structure is different from the one used in the ossj and tck-ossj projects, each file will have to be copied into the new environment. Once fully transferred and tested, the spec leader will ask the java.net administrator to remove the obsolete branches from ossj and tck-ossj projects.
Need more practical info here, Any volonteer?
|