head	1.3;
access;
symbols
	dlr:1.1.1
	TIGRIS_0_9_2_4:1.1
	TIGRIS_0_9_2_3:1.1
	HELM_PEER_PORT_BRANCH:1.1.1.1
	TURBINE_PEER:1.1
	TIGRIS_0_9_2_1:1.1
	TIGRIS_0_9_2:1.1.0.6
	TIGRIS_0_8_4:1.1.0.4
	TIGRIS_0_9_0:1.1.0.2;
locks; strict;
comment	@# @;


1.3
date	2001.03.12.18.19.27;	author lori;	state dead;
branches;
next	1.2;

1.2
date	2001.03.10.01.28.07;	author tberry;	state Exp;
branches;
next	1.1;

1.1
date	2001.01.08.21.53.20;	author susank;	state Exp;
branches
	1.1.1.1
	1.1.4.1;
next	;

1.1.1.1
date	2001.02.21.00.32.01;	author dlr;	state Exp;
branches;
next	;

1.1.4.1
date	2001.01.16.00.17.44;	author susank;	state Exp;
branches;
next	;


desc
@@


1.3
log
@this file deprecated for 1.0 release; DO NOT USE THIS FILE
@
text
@<span class="PlainText">

<span class="Header">Help Pages:</span> <span class="ProjectHeader">Table of Contents</span>

<br>
<hr size="1" noshade>

<SPAN class="HelptextHeader">Site help: about using SourceCast</SPAN> 
<ul>
  <dl>
	<dt><A href="#Introduction">Introduction</A>
	<dd><li><A href="#firsttimeusers">For first-time users</A></li>
        <dd><li><A href="#before">Before you join a project</A></li>
        <dd><li><A href="#aboutsubscribing">About subscribing to mailing lists</a></li> 
	<dd><li><A href="#after">Once you join a project</A></li>
	<dd><li><A href="#UserEdit">About your user profile (username, password, and more)</a></li></dd>
  </dl>
</ul>

<ul>
  <dl>
	<dt><A href="#NavigatingWebspace">Navigating SourceCast</a>
        <dd><li> <A href="#NavigatingWebspace">SourceCast: the left navigation bar</a></li>
        <dd><li><A href="#StartPage">My Start Page: sections</a></li></dd>
  </dl>
</ul>

<SPAN class=HelptextHeader>Project help: about joining and starting projects</SPAN>
<ul>
  <dl>
        <dt><A href="#Joining">Joining a project</a>
        <dd><li><A href="#Learning">Learning about projects</a></li>
        <dd><li><A href="#ProjectMembershipRequest">Becoming a project member</a></li>
        <dd><li><A href="#ProjectRoles">About project roles</a></li></dd>
  </dl>
</ul>

<ul>
  <dl>
        <dt><A href="#ProjectAdd">Starting a new project</a>
        <dd><li><A href="#ProjectAddStep1">Create New Project (Step One): Naming and describing your project</a></li>
        <dd><li><A href="#ProjectAddStep2">Create New Project (Step Two): Choosing your project's license and profile </a></li> 
        <dd><li><A href="#ProjectAddStep3">Create New Project (Step Three): Inviting people to join your project</a></li>
        <dd><li><A href="#ProjectAddStep4">Project Creation Confirmation</a></li></dd>
  </dl>
</ul>

<ul>
  <dl>
        <dt><A href="#ProjectEdit">Administering the project</A>
	<dd><li><A href="#ProjectEdit">Editing the project</A></li>
	<dd><li><A href="#ownersmessage">Creating the owner's message</a></li>
	<dd><li><A href="#projmailinglist">Configuring the project's mailing lists</a></li></dd>
  </dl>
</ul>

<ul> 
  <dl>
   
       	<dt><A href="#AdminProjectResources">Project Resources for administrators and members</A></A>
        <dd><li><A href="#ProjectHomePage">Project Home Page</a></li><dd>
        <dd><li><A href="#ProjectNews">Project News</a></li><dd>
        <dd><li><A href="#ProjectDownload">Project Download</a></li><dd>
        <dd><li><A href="#ProjectMembers">Project Members</a></li><dd>
        <dd><li><A href="#ProjectMail">Project Mailing Lists</a></li><dd>
        <dd><li><A href="#ProjectSource">Project Source Code</a></li><dd>
        <dd><li><A href="#ProjectIssues">Project Issues</a></li><dd>
        <dd><li><A href="#ProjectAdmin">Project Admin</a></li><dd></dd>
  </dl>
</ul>

<SPAN class=HelptextHeader>Licenses</SPAN>
<span class="PlainText">
<ul>
  <dl>
        <dt><A href="#Public">Public</a>
	<dd><li><A href="#Apache">Apache</A> </li>
	<dd><li><A href="#BSDStyleLicenses">BSD</A></li>
	<dd><li><A href="#GPL">GNU General Public License (GPL)</A></li></dd>
  </dl>
</ul>

<ul>
  <dl>
	<dt><A href="#Proprietary">Private</a>
	<dd><li><A href="#Proprietary">Proprietary</A></li></dd>
   </dl>
</ul>

<HR noShade SIZE=1>

<SPAN class=ProjectHeader>Site help: about using SourceCast</SPAN> 

<p><br><br><A name="Introduction"></A><SPAN class="HelptextHeader"><b>Introduction</b></SPAN><br>

<span class="PlainText">

<p>This "How To" document has been designed with the aim of 
answering any and all questions you might have related to the pages of 
SourceCast available to all registered users. Who is a "registered user"? You 
are: As a member of the <!--  --> CollabNet developer site, you are automatically a <b>registered user</b> on SourceCast. So, read the Site <A href="DomainFAQ.html">FAQ</a> and take a look around to get a sense of the range of possibilities available to you...</p> 


~~~
<ul>
<li>from simply joining a project as an observer 
  
<li>to actively contributing to a project 
  
<li>to proposing and leading your own project.</li>
</ul>

<p>In general, developers instigate ideas, projects, and resources. Registered users then join the community working on those projects that appeal most to them. Developers must then craft projects that not only will be approved by the site administrators, but also be appealing enough to attract users. As a result of this dynamic, the projects in SourceCast created by the Project Owner (the developer with an approved project) will be interesting and worthwhile not just for the developer, but for others. </p>

<p>This same dynamic in turn governs individual project administration: either directly or indirectly, project owners determine each project's direction and membership. Indirectly, in that a project with a minimum threshold for entry might be presented in such a way as to appeal to a certain developer, and directly, in that the project owner might invite certain developers to join her project or, quite often, review requests for membership in the project community. The upshot is that to join a project (if you haven't been invited to join), you have to request membership and receive the project owner's approval. (<A href="ProjectHome">More about joining a project</a>.) </p>

<p><br><br><A name="firsttimeusers"></A><SPAN class=HelptextHeader><b>For first-time users</b></SPAN><BR>

<p><br><br><a name="before"></a><span class="HelptextHeader"><b>Before you join a project: what you can do</b></span><br>

<p>The natural place to start (and it is also the default) is the <A href="#StartPage">"My StartPage,"</a> which presents you with, among other things, a generous category list of currently hosted projects and a navigation bar on the left listing useful and important links. Each of these items is available for browsing. In fact, before you have even joined a project, you can:</p>
  
<ul>
<li>View category and project home pages 
  
<li>Read project news pages 
  
<li>Read the SourceCast <A href="DomainFAQ.html">FAQ</a> and <A href="TermsOfUse.html">Terms of Use</a> documents 
  
<li>Edit your user login ID and password 
  
<li>Download sample source code 
  
<li>Join project mailing lists 
  
<li>Propose your own project</li>
</ul>
<p>These items will be touched on throughout this document, as they are common to all users alike. Each item provides some insight either into the structure of SourceCast or into particular projects and their communities of developers. Investigating the categories, for instance, can give you a fair idea of the project at hand, as can reading the project news pages.</p>
<p><br><br><a name="aboutsubscribing"></a><span class="HelptextHeader"><b>About subscribing to project mailing lists</b></span><BR>

<p>One of the best ways to learn not only about a particular project but get a feel for the community that is working on it, is to subscribe to the mailing lists associated with that project. You may even be able to post your own ideas for the project as a way of introducing yourself to the project team. However, your ability to subscribe to project mailing lists depends on the project's licensing. Most open-source projects will allow you to subscribe before actually joining the project, depending upon the project owner's preference. </p>

<p>In the case of proprietary projects, you may need approval to join the project at the most basic "observer" level before you can subscribe to any 
mailing lists. <A href="DomainDocsMailingLists">Read more about mailing lists</a>.</p>

<p><br><br><a name="after"></a><span class="HelptextHeader"><b>Once you join a project: what you can do</b></span><BR>

<p>Part of the point of SourceCast is, of course, to encourage developers to join and create projects. Consequently, we have made the process as painless as possible; and we have provided some advantages. In fact, there are no disadvantages. Joining a project gives you the tools and the community to realize your goals. As a member of a project you can:</p>

<ul>
<li>Download source code 
  
<li>Upload files and documents 
  
<li>Participate in project mailing lists 
  
<li>Query and report project issues 
  
<li>Use other hosted  development tools like CVS versioning control. (<A href="DomainDocs">What are these tools?</a>)</li>
</ul>

<p>Your degree of access to files and your ability to do things depends upon the project's licensing (open source or proprietary) and your particular role in that project. (You can change your role; as a member, you can't change the project licensing.) <A href="#AboutProjectRoles">Later, we discuss the intricacies of project roles</a>.</p>

<p><br><br><a name="UserEdit"></a><span class="HelptextHeader"><b>About your user profile</b></span><BR>

<p>Clicking the <B>Edit Profile</B> link 
in the upper right corner of your Start Page displays a screen where you can 
edit your profile, including your username and password for SourceCast, and your 
email address. Because SourceCast and the <!--  --> CollabNet developer site share the same user database, changing your username or password here also changes your developer login information.

<p>Once you become a member of any SourceCast development projects, the User Edit screen lists your roles with those projects. These are linked to enable you to navigate directly to the project's home page. Clicking on any hyperlinked project takes to that project, where you can change your role by clicking on "Request New Project Role."</p>
 
<p><br><br><a name="NavigatingWebspace"></a><span class="HelptextHeader"><b>Navigating SourceCast</b></span><br>

<p><br><br><a name="webspaceleftbar"></a><span class="HelptextHeader"><b>SourceCast: the left navigation bar</b></span><BR>
<p>The discussion below explains the various tabs of the left navigation bar. The bar is a constant throughout SourceCast, and provides invaluable resources.</p>
<ul>
<li><b>My Start Page:</b> Clicking on 
  this button from anywhere in SourceCast returns you to your customized start 
  page. 
  
<li><b>Hosted Projects:</b> This page 
  lists all projects hosted on this site, organized by category, with important 
  details: project name, type of license, and a short description of what the 
  project is about. Click on any project listed to visit the project's home page 
  for more information. 
  
<li><b>Help:</b> A link to this help 
  document you are currently reading. 
  
<li><b>Tool Docs:</b> Important 
  documentation about how to use the tools necessary for managing and 
  administering projects, filing issue reports, and more. 
  
<li><b>Site FAQ:</b> Basic questions 
  and answers about this site. 
  
<li><b>Feedback:</b> A page where you 
  can submit feedback on the SourceCast website and submit requests for 
  technical support. 
  
<li><b>Logout:</b> Click here to log 
  you out of SourceCast.</li>        
</ul>

<p><br><br><a name="StartPage"></a><span class="HelptextHeader"><b>My Start Page: sections</b></span><BR>

<blockquote>
<b>My Projects</b><br>This list captures all SourceCast development projects in which you have a role.<br><br>
<b>Pending Requests</b><br>
Your pending activities are tracked here: projects awaiting approval, requests to join projects, and project documents you have agreed to review.<br><br>
<b>Hosted Project Categories</b><br>
All projects currently hosted on SourceCast are listed by category. Projects are grouped into categories according to development or application type. Thus, those projects dealing with games are associated together. As a result, you can quickly see what sort of projects are available in your areas of interest. Category names in this section link to category home pages, where projects are listed by individual name with short descriptions.
<A href="#ProjectCategoryHome">Read more about project categories</a>.  
</blockquote>

<p><hr size="1" noshade>

<p><a name="ProjectHelp"><span class="ProjectHeader">Project help: about joining and starting projects</span>

<p><br><br><A name="Joining"></A><SPAN class="HelptextHeader"></a><b>Joining a project</b></span><br>
  
<p>As a registered user on SourceCast, you can go to any project's home page and see what's there. Likely as not, the project owner has made an effort to provide interesting material; in fact, it might be compelling enough to induce you to join. Joining projects (yes, you can join more than one) opens up greater access to the powerful features and development tools available to you on this site. The following section describes how to navigate this site to find information and join a project.</p>

<p><br><br><a name="Learning"></a><span class="HelptextHeader"><b>Learning about projects</b></span><br>

<p>Click on the <b>Projects</b> button on the left navigation bar. You will be taken to the Hosted Projects page, where all the projects are listed by category. View the listed projects; clicking on any takes you to that project's home page. 

<p><a name="ProjectCategoryHome"></a>You can also view lists of projects within a specific category using the <B>Project Category Home</B> page. To get there, choose a project category and click it. The Project Category Home page is where you can view all those projects sharing the same category. Project names on this page link to each project's home page.</p>
 
<p><A name="ProjectHome"></A>The <B>Project Home</B> page for any particular project is the 
project's focal point with information that the project owner wishes to share 
with members and nonmembers alike. Because project home pages can be customized, 
these vary greatly, depending on the project owner's preferences. At a minimum, 
the owner should include content describing the nature and goals of the project. 
Interested users can also use the project's hyperlinks in the Project Resources 
tool bar above to learn more about the project, including subscribing to that 
project's mailing lists.</A>.</p>

<p><br><br><a name="ProjectMembershipRequest"></a><span class="HelptextHeader"><b>Becoming a member</b></span><BR>

<p>To request membership in a project, click <I>Join this Project</I> on the far right side of the screen in the <B>Project Home</B> page, which takes you to the <B>Project Membership Request</B> page. (If you are already a member of that project, the link changes to reflect your status.) The pull-down menu in the middle of the page presents you with several role options. Think of the roles as means to inform the project owner how you intend to contribute. You may request or even be asked to fulfill more than one role at some point, and you can certainly fulfill other roles on different projects.
</p>
<P>Depending on the project's configuration, you will receive email from the project owner approving or disapproving your project membership. Upon being approved, you will also receive more information about the nature of the particular module you will be working on.</P>

<p>Once you are a project member and your involvement progresses, you may wish to change your role in a project. The Project Home page includes a <I>Request New Project Role</I> link in the top right corner of the same page you originally used to request membership originally in the project. Now, however, your current role is noted in the top section, and only the remaining roles available to you are displayed with radio buttons. Again, you submit this change as a request that the project owner must approve.</p>

<p>As a project member, you are able to work with the full set of hosted tools. These include signing up for tasks, reporting issues using IssueZilla, and obtaining project source code using CVS. See specific pages for more information about these tools, and read the <A href="/DomainDocs">Tool Docs</A>.</p>
<p> 
<p><br><br><a name="ProjectRoles"></a><span class="HelptextHeader"><b>About project roles</b></span><br>

<blockquote>
<b>Observer</b><br> You have "read-only" access to most project pages, files, and documents. You can view and query project issues, browse project source code files, subscribe to project mailing lists and post messages, but you do not contribute directly to the project.

<p><b>Developer</b><br>
You gain read and write access to view and download <b>all</b> project pages, files, and documents. You can browse and checkout project source code files, and subscribe and post messages to project mailing lists. You query, report, and respond to project issues, and you can contribute code and patches.

<p><b>Content Developer</b><br>
You have read and write access to develop and manage a project's web content, including project news. You can also query, report, and respond to project issues, browse and checkout project source code files, and subscribe and post messages to project mailing lists.


<p><b>Project Owner</b><br>
You define the project's overall mission, direction, 
  methodology, and community make-up. As owner, you can also reconfigure the 
  project to address emerging concerns and control membership. You are also the 
  default moderator of all project mailing lists.</p>
                                    
</blockquote>

<p><br><br><A NAME="ProjectAdd"></A><SPAN CLASS="HelptextHeader"><b>Starting a new project</b></SPAN></A><br>
<p><br><br><A NAME="ProjectAddStep1"></A><span class="HelptextHeader"><b>Create a New Project (Step One): Naming and Describing your project</b></span><br>

<p>Say you want to create your own project. It's easy! But, all the same, you might want to read these instructions to get a sense of what you should do first--so that you don't have to redo it.</p>
<p>If you wish to start your own project, begin by defining the project's mission and goals. The process is fairly simple; however, you should probably come to the task prepared, with a good sense of what you want and how you want to accomplish it. Knowing whom to invite onto your project won't hurt, either. The <i>Start a project </i>link on the My Start Page (and several other pages) leads you through a three-step process to turn your idea into a pending project. Once you complete this process--and it doesn't take long--a special home page specific to your project is generated. Your project home page is the focal point for everything having to do with your project, and all registered users can view it. It is therefore important that you create a page that is as informative as it is inviting.</p>

<P><BLOCKQUOTE><a name="ProjectNameField"></a><B>Project Name</B><BR>
Enter what you wish to call your project. Choose a name 
  that both describes the project and conforms to the naming conventions. That 
  is, use the a-z, 0-9, and dash (but not as first character); no spaces, 
  underscoring, capitalization, or other punctuation. Keep in mind that the 
  project name cannot be changed. An example of a name for a project dealing 
  with porting a sophisticated chess game to the telephone might be 
  "chessphone." Unimaginative, to be sure, but descriptive.
  <P></P>

<P><a name="SummaryField"></a><B>Summary</B><BR>
Enter a one-line description of your project, no longer than the field length. The description should be in plain text; HTML and formatted text are not supported. The description will be adjacent to the name of the project and be what registered users see first when they view the list of available projects. It should therefore be descriptive and concise. For instance, in the case of the chess game, you might write: "Porting an advanced chess game to the phone." Unlike the project name, you can edit this field at any time.</P>

<P><a name="DescriptionField"></a><B>Description</B><BR>
This description makes up the bulk of your project's home page. It is where you can present the project in as interesting a light as possible. You can include HTML, formatted text, and so on, but keep in mind that most developers prefer simple and fast over complicated and slow (and confusing). State here your project's mission, background, methodology, tasks available, and other information that a developer might need to begin working on your project. This field can be edited at any time by clicking on the "Edit Project" link once you have finished creating a project, but the information should remain consistent.

<p><a name="URLAliasField"></a><B>URL Alias</B><BR>
You can choose either to have your project URL hosted through the SourceCast domain, a third party customer's domain, or directed to your own domain name (if you own one). In the latter two cases, you can direct the DNS entry to SourceCast as a virtual host, so your project's page requests are handled by SourceCast's servers. Otherwise, leave this entry blank. All projects are assigned a URL as: PROJECTNAME.[domainname].[com]. This feature can be edited later by clicking on the "Edit Project" link once you have finished.</p></BLOCKQUOTE>
<P></P>

<span class="PlainText">

<P><br><br><a name="ProjectAddStep2"></a><span class="HelptextHeader"><b>Create a New Project (Step 2): Choosing your project's license and profile</b></span><br>

<P><BLOCKQUOTE>

<P><a name="LicenseField"></a><B>License</B><BR>
Choose the license you wish to apply to the project. Licenses can range from the open source GPL to proprietary. Once your project is approved, you cannot switch from an open-source model to a proprietary one. However, proprietary projects can choose to go open source. To edit this feature of your project, you need to click on "Edit Project" link, once you have finished the process of creating the project. <A href="#TypicalLicenses">Read more about licenses.</a></P>

<P><a name="ProjectCategoryField"></a><B>Project Category</B><BR>
Select the category appropriate for your project. Because projects are listed by category in both the Start Page and Projects home pages, the choice of category is critical for giving developers a sense of the kind of work available. A developer who specializes in games, for example, will not necessarily want to view projects in the productivity category. As you can see, there are many possible options, and if you end up preferring another category, you can change your project category at any time. To edit this features of your project, click on "Edit Project" once you have finished creating the project.</P>
 
<P><a name="ProjectProfileField"></a><B>Project Profile</B><BR>
The Project Profile buttons are configured to automatically create mailing lists for your particular project. Perhaps you have a project idea that will require much discussion and input from other developers well before getting to the point of actual source code; this would be a "Discussion project." If your project, on the other hand, involves reworking existing source code, choose "Standard development project." Selecting a content project generates a standard mailing list; you would not have access to the issue-tracking system because it would not be necessary. Selecting the source code instance generates five mailing lists, and gives you access to all of the other resources of the site, including issue tracking. It is important to stress that no matter what profile you choose, you can change it later.</P>
</BLOCKQUOTE>
<P></P>

<span class="PlainText">

<p><br><br><a name="ProjectAddStep3"></a><span class="HelptextHeader"><b>Create New Project (Step 3): Inviting people to join your project</b></span><br> 


<P>Invite as many people as you wish by listing their email addresses, one email address per line, or multiple addresses if each address is separated by a comma, colon, or semicolon. Automatically generated invitations to each invitee will be sent; you can use the field below to include a personal message, perhaps a brief explanation of your project's purpose, why you think he or she might find it worthwhile to join in, and a link providing direct access to your project home page.</P>
<p>Recipients of your invitation who are already registered <!--  -->CollabNet 
developers log in to <!--  --> CollabNet's developer site to view your SourceCast project home page. To join your project, they click the "Join This Project" link.</p>
<p>If the person you're inviting is <i>not</i> a registered <!--  -->CollabNet 
developer, the email invitation asks her to register first as a <!--  --> CollabNet developer to obtain a login and password by email. Then this person is able to log in and view your SourceCast project home page.</p> 

<p>Recipients of your invitation who are already registered <!--  -->CollabNet 
developer's must log in to <!--  --> CollabNet's developer site before they can view your SourceCast project home page. If they wish to join your project, they can click the "Join This Project" link.

<p>If the person you're inviting is <I>not</I> a registered <!--  -->CollabNet 
developer, he/she is instructed by the email invitation to register first as a <!--  --> CollabNet developer to obtain a login and password by email. Then this person is able to log in and view your SourceCast project home page.

<P><blockquote><a name="InvitationMessageField"></a><B>Invitation Message</B><BR>
<span class="PlainText"><P>This message should be brief, but clear and informative. You can include hyperlinks, and any other information that you think would promote your project. Formatting and HTML are not, however, supported--the message, that is, stands on what it says not on how it looks. Hint: write out what you want to say beforehand. That way, you won't be lost for words. Finally, all the other project information is automatically generated, so you don't have to worry about including it again.</P></span>
</blockquote>
<P></P>

<span class="PlainText">

<p><br><br><a name="ProjectAddStep4"></a><span class="HelptextHeader"><b>Project creation confirmation</b></span><br>

<P>When you finish filling out all the fields and writing the messages, click <b>Finish,</b> which takes you to the confirmation page. From there, you can go to your newly created project home page.</P>

<P>While your project's status is pending, you can do many things to enhance your project's appeal. You can:</P>

<ul>
<li>Customize your project home page content 
  
<li>Add, configure, or delete mailing lists 
  
<li>Upload source files and documents 
  
<li>Invite additional participants</li>
</ul>

<p>In short, you can use most of the project functionality while waiting for project approval. Once your project is approved, you can accept member requests and solidify the community.</p>

<p><br><br><A name="ProjectEdit"></A><SPAN class="HelptextHeader"><b>Administering the project</b></SPAN><br>

<p><br><br><a name="ProjectEdit"></a><span class="HelptextHeader"><b>Editing the project</b></span><br>

<P>All project configuration and management activities begin with the Administrate Project page. You access this page for your project in a couple of different ways:</P>

<UL>
<LI>In your My Start Page, your project appears under "My Projects." Clicking on the project name takes you to the Project Home page where an "Edit this project" link appears in the top right corner.
<LI>You can also click the "Admin" link in the "My Projects" section of your Start Page. This link only appears with projects you own.
<LI>In all project pages, an "Admin" link appears in the 
  Project Resources tool bar.</LI>             
</UL> 

<P>You can edit your project here to change how project information is displayed in your project home page and project listings. Most of these fields mirror the fields in the project creation process: Project Name, Summary, Description, URL Alias, License, and Project Category. You can edit these fields as necessary, but basic project information should remain fairly constant.</P>

<p>Two new fields in this screen are: </p>

<p><br><br><a name="ownersmessage"></a><span class="HelptextHeader"><b>Owner's Message</b></span><br>

<p>Enter a brief message to be included in your project home page. Some of the ways to use this field may include: 
        <ul>
        <li>Identifying yourself as the project owner 
        <li>Giving brief project highlights, updates, or 
  milestones 
        <li>Advertising your project's resource needs, for example: "Desperately seeking experienced Java servlet developers with a passion for creating apps that will change the world." Lame, perhaps, but you get the point.</li>
      </ul>

<p>In contrast to the project summary field on your project home page, the owner's message should tell more about the current status of development. This information should be regularly updated, say every week or at least monthly.</p>

<p><br><br><a name="projmailinglist"></a><span class="HelptextHeader"><b>Mailing Lists</b></span><br>

<p>Newly created source-code projects include a default set of five preconfigured lists. These cover the basics of development. You may choose to add additional lists using this <I>new</I> link to access the Mailing List Add page. To change how default project mailing lists are configured, use the <I>MailingLists</I> link in the Project Resources toolbar. 

<p><br><br><A name="AdminProjectResources"></A><SPAN class="HelptextHeader"><b>Project resources for administrators and members</b></SPAN><br>

<P>All registered users see the "Project Resources" toolbar at the top of project home pages. Although this tool bar always appears in every project page and provides access to project pages, the information displayed in those pages depends upon the user's status or role in a project.</P>

<UL>
<LI>Registered users who are not project members, do not see the "Members" link at all. Rather, they can view limited project information using other links in the tool bar.
<LI>Project members have more access based upon their roles.
<LI>Project owners see additional administrative options 
  on each project page.</LI>         
</UL>

<P><br><br><a name="ProjectHomePage"></a><span class="HelptextHeader"><B>Project Home page</B></span><br>

<P>This link always returns you to the project home page.  

<p><br><br><a name="ProjectNews"></a><span class="HelptextHeader"><B>Project News</B></span><br> 

<P>Links for project announcements, milestones, and articles appear on this page.

<a name="ProjectNewsAdd"></a>Project owners see a link in the top right corner to "Add a News Item." The Project News Add page features input fields for the heading and body of news items to appear in your Project News page. An additional publishing feature lets you specify dates to automate when each news document appears in the Project News screen and when it is archived.

<p><br><br><a name="ProjectDownload"></a><span class="HelptextHeader"><b>Project Download</b></span><br>

<P>Downloadable project files are displayed in the "Download" section. New files may be uploaded in the "Add or Replace a Download" section. Project members look here to download project specifications, files, and documents, or to contribute their own project documents. This screen contains no additional administrative features.

<P>To download a file from the project home page, click on the title of the file. The download should then commence immediately. 
<P>To upload a file, type in the URL and/or filename, or use the <I>Browse</I> button to select the file from your hard drive, then click the <I>Upload File</I> button. The upload will immediately commence.

<p><br><br><a name="ProjectMembers"></a><span class="HelptextHeader"><B>Project Members</B></span><br>

<P>All project members and their roles are listed here, with associated links to view project issues specifically assigned to each person. As the project owner, you (and any project participants you assign with an administrative role) can also see:

<UL>
<LI>A button to revoke membership roles
<LIA     
<LI members new add to link>A section listing pending 
  project membership requestors by name </LI>         
</UL>

<p><br><br><a name="ProjectMail"></a><span class="HelptextHeader"><B>Project Mailing Lists</B></span><br> 
<dl>
<dt>To subscribe:
<dd><li>If your mail client is configured for browswer-based mail, click on the hyperlinked mailing list address to which you want to subscribe.</li>
<dd><li> If your mail client is not configured for browswer-based mail, simply copy the hyperlinked mailing list address and paste it into the "To" field in a new email message.</li>
<dd><li> Send the message from your email client. You should receive a response asking for a confirmation.</li>
<dd><li> Reply as indicated. You will receive an email welcoming you on your successful mailing list subscription.</li></dd>
</dl> 
<p>Unsubscribing is the same process, only instead of using the "subscribe" buttons or
addresses, you use "unsubscribe."</p>
<p>Once on the Mailing Lists page, you can view the project mailing list archives by clicking on the "view archive" link next to the mailing list title for that list. Click on the date range and subject links to specify the sort of messages you want to see.</p>
<P>All mailing lists associated with the project are listed here. The links on this page allow you to subscribe (or unsubscribe) to the available mailing lists. 

<p><br><br><a name="ProjectSource"></a><span class="HelptextHeader"><B>Project Source</B></span><br>

<P>You can either browse the source code online with a Web browser or check out source code files via CVS (command line). If you are unfamiliar with CVS, the page lists valuable sources for learning more about the protocols and use of CVS. You can also find information using the <A href="/DomainDocsCVS">Tool Docs</A> link in the left navigation bar.

<p><br><br><a name="ProjectIssues"></a><span class="HelptextHeader"><B>Project Issues</B></span><br>

<P>All project activities are tracked in an <A href="/DomainDocsIssues">issue database</A>. As used here, "Issue" is a term encompassing bugs, features, enhancements, tasks, and patches. An issue, that is, is a task. The advantage of using the issue tracker is that it keeps a file of those issues (including important specifications) you've agreed to take on. Issues can be reassigned.

<p><br><br><a name="ProjectAdmin"></a><span class="HelptextHeader"><B>Project Admin</B></span><br>

<P>This link always displays the <B>Project Edit</B> page. That is, by clicking on it you are immediately take to the page where you can edit (or administrate) your project.</P>

<hr size="1" noshade>

<a name="TypicalLicenses"></a><b><span class="ProjectHeader">Licenses</span></b>

<p><br><br><span class="HelptextHeader"><b>Software is controlled by copyright</b></span></p>

<p>Determining whether to license your project using one of the open-source licenses or whether to make your project proprietary is a difficult decision and should be taken only after the careful consideration of the consequences. Keep in mind that software is copyrighted. The software creator holds a copyright on the code, which allows the person or entity (it can be a corporation) to control how copies are made, for both source and binary forms. When the copyright holder sells a license to use the code, the copyright holder retains copyright but the licensee gains the legal right to use the code or compiled program in the manner dictated by the license. </p>

<p>Below, we have provided brief descriptions of the more commonly used open-source licenses. All of these open-source licenses share three central provisions:</p>
    
<ul>
      <li>Free redistribution (branded distribution can be sold) 

      <li>Source code must be publicly available 
      <li>No restrictions on making and distributing modifications </li>
</ul>

<p>We have also included the option of keeping the code proprietary, or closed source. The choice of open or closed source rests finally upon how you wish to configure project.

<p><br><br><br><a name="Public"></a><span class="HelptextHeader"><b>Public</b></span><br>

<a name="Apache"></a>

<p><b><A href="http://www.apache.org/LICENSE-1.1.txt">The Apache license</A></b><br>
The Apache license stipulates that any redistribution of the software include the text, "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." This is often called the "Acknowledgment Clause." The original BSD license had a similar clause as well, but it was removed in July of 1999. Having the clause promotes awareness of the product; removing it simplifies the act of redistribution. The Apache license also reworks the  BSD's third restriction into a pair of restrictions that protect the name "Apache" from being used as the name of a derived product or to endorse the derived product.

<a name="BSDStyleLicenses"></a>

<p><b><a href="http://www.opensource.org/licenses/bsd-license.html">The BSD license</a></b><br>
Developed by the University of California, Berkeley, the BSD license is the most unrestricted of the open-source licenses. It allows for use, modification, and redistribution subject to three simple restrictions (paraphrased): 

<ul>
<li>The files must retain their original copyright and 
  license 
  
<li>Binary redistributions must include a copy of the 
  copyright and license somewhere in the distribution 
  
<li>The names of the project creators and contributors may not be used to endorse products derived from the software without permission</li>
</ul>

It also includes a standard disclaimer of warranty.

<a name="GPL"></a>

<p><b><a href="http://www.gnu.org/copyleft/gpl.html">The GNU General Public License (GPL)</a></b><br>
The GNU GPL, created by <a href="http://www.fsf.org/">the Free Software Foundation</a>, was the first open-source license and, in its insistence on keeping source code free, it remains the strictest. In a nutshell, the GPL stipulates not only that all "free" code must remain "free," but that all code derived in part or in whole from such code must be fall under the same license terms as the original code. On the face of it, the license would seem to encourage nonprofit development and discourage commercial interests. However, as Brian Behlendorf has argued, the GPL can provide a vehicle for the widespread establishment of a platforms that indirectly enhance commercial interests.

<p><br><br><br><a name="Proprietary"></a><b><span class="HelptextHeader">Proprietary</A></b><br>

<p>It is by no means the case that the open-source method is always the best. You can, if you wish, keep your work closed source. This means that others cannot freely work on it without your express permission.
<p><b>Select open source references<b><br>
<ul>
<li> <a href="http://www.opensource.org/">The Open Source Initiative.</a> An open-source advocacy 
  group whose site houses useful links and information. 
  
<li> <a href="http://www.stromian.com/Open_Source_Licensing.htm">The Open Source Software
Licensing Page.</a> A very useful 
  site listing open-source licenses, with links to the originals and sponsoring 
  institutions or persons. 
  
<li> <a href="http://www.tuxedo.org/~esr/writings/cathedral-bazaar/">The Cathedral and the
Bazaar.</a> Eric Raymond's famous 
  manifesto on open source. Required reading. 
  
<li><a href="http://user.cs.tu-berlin.de/~tron/opensource/"> An Introduction To Open Source
Software Development.</a> A comprehensive work by Steffen Evers describing open-source 
software development.</li>
</ul>

</span></B></B></span></span></span></span></SPAN></SPAN>@


1.2
log
@fixed broken link
PR:
Obtained from:
Submitted by:
Reviewed by:
@
text
@@


1.1
log
@genericized these files and copied over from inst.  Now they are default, here.
PR:
Obtained from:
Submitted by:
Reviewed by:
@
text
@d1 522
a522 444
<span class="PlainText">

<span class="Header">Help Pages:</span> <span class="ProjectHeader">Table of Contents</span>

<br>
<hr size="1" noshade>

<SPAN class="HelptextHeader">Site help: about using SourceCast</SPAN> 
<ul>
  <dl>
	<dt><A href="#Introduction">Introduction</A></dt>
	<dd><li><A href="#firsttimeusers">For first-time users</A></li></dd>
        <dd><li><A href="#before">Before you join a project</a></li></dd>
        <dd><li><a href="#aboutsubscribing">About subscribing to mailing lists</a></li></dd> 
	<dd><li><A href="#after">Once you join a project</a></li></dd>
	<dd><li><a href="#UserEdit">About your user profile (username, password, and more)</a></dd></li>
  </dl>
</ul>

<ul>
  <dl>
	<dt><a href="#NavigatingWebspace">Navigating SourceCast</a>
        <dd><li> <a href="#NavigatingWebspace">SourceCast: the left navigation bar</a></li></dd>
        <dd><li><a href="#StartPage">My Start Page: sections</a></li></dd>
  </dl>
</ul>

<SPAN class=HelptextHeader>Project help: about joining and starting projects</SPAN>
<ul>
  <dl>
        <dt><a href="#Joining">Joining a project</a>
        <dd><li><a href="#Learning">Learning about projects</a></li>
        <dd><li><a href="#ProjectMembershipRequest">Becoming a project member</a></li>
        <dd><li><a href="#ProjectRoles">About project roles</a></dd>
  </dl>
</ul>

<ul>
  <dl>
        <dt><a href="#ProjectAdd">Starting a new project</a></dt>
        <dd><li><a href="#ProjectAddStep1">Create New Project (Step One): Naming and describing your project</a></li></dd>
        <dd><li><a href="#ProjectAddStep2">Create New Project (Step Two): Choosing your project's license and profile </a></li></dd> 
        <dd><li><a href="#ProjectAddStep3">Create New Project (Step Three): Inviting people to join your project</a></li></dd>
        <dd><li><a href="#ProjectAddStep4">Project Creation Confirmation</a></li></dd>
  </dl>
</ul>

<ul>
  <dl>
        <dt><A href="#ProjectEdit">Administrating the project</A></dt>
	<dd><li><A href="#ProjectEdit">Editing the project</A></dd></li>
	<dd><li><a href="#ownersmessage">Creating the owner's message</a></dd></li>
	<dd><li><a href="#projmailinglist">Configuring the project's mailing lists</a></dd></li>
  </dl>
</ul>

<ul> 
  <dl>
   
       	<dt><A href="#AdminProjectResources">Project Resources for administrators and members</A></a></dt>
        <dd><li><a href="#ProjectHomePage">Project Home Page</a></li><dd>
        <dd><li><a href="#ProjectNews">Project News</a></li><dd>
        <dd><li><a href="#ProjectDownload">Project Download</a></li><dd>
        <dd><li><a href="#ProjectMembers">Project Members</a></li><dd>
        <dd><li><a href="#ProjectMail">Project Mailing Lists</a></li><dd>
        <dd><li><a href="#ProjectSource">Project Source Code</a></li><dd>
        <dd><li><a href="#ProjectIssues">Project Issues</a></li><dd>
        <dd><li><a href="#ProjectAdmin">Project Admin</a></li><dd>
  </dl>
</ul>

<SPAN class=HelptextHeader>Licenses</SPAN>
<span class="PlainText">
<ul>
  <dl>
        <dt><a href="#Public">Public</a></dt>
	<dd><li><A href="#Apache">Apache</A> </li></dd>
	<dd><li><A href="#BSDStyleLicenses">BSD</A></li></dd>
	<dd><li><A href="#GPL">GNU General Public License (GPL)</A></li></dd>
  </dl>
</ul>

<ul>
  <dl>
	<dt><a href="#Proprietary">Private</a></dt>
	<dd><li><A href="#Proprietary">Proprietary</A></li></dd>
   </dl>
</ul>

<HR noShade SIZE=1>

<SPAN class=ProjectHeader>Site help: about using SourceCast</SPAN> 

<p><br><br><A name="Introduction"></A><SPAN class="HelptextHeader"><b>Introduction</b></SPAN><br>

<span class="PlainText">

<p>This "How To" document has been designed with the aim of answering any and all questions you might have related to the pages of SourceCast available to all registered users. Who is a "registered user"? You are:  As a member of the <!--  --> CollabNet developer site, you are automatically a <b>registered user</b> on SourceCast. So, read the Site <a href="DomainFAQ.html">FAQ</a> and take a look around to get a sense of the range of possibilities available to you...</p> 


~~~
<ul>
<li>from simply joining a project as an observer </li>
<li>to actively contributing to a project </li>
<li>to proposing and leading your own project.</li>
</ul>

<p>In general, developers instigate ideas, projects, and resources. Registered users then join the community working on those projects that appeal most to them. Developers must then craft projects that not only will be approved by the site administrators, but also be appealing enough to attract users. As a result of this dynamic, the projects in SourceCast created by the Project Owner (the developer with an approved project) will be interesting and worthwhile not just for the developer, but for others. </p>

<p>This same dynamic in turn governs individual project administration: either directly or indirectly, project owners determine each project's direction and membership. Indirectly, in that a project with a minimum threshold for entry might be presented in such a way as to appeal to a certain developer, and directly, in that the project owner might invite certain developers to join her project or, quite often, review requests for membership in the project community. The upshot is that to join a project (if you haven't been invited to join), you have to request membership and receive the project owner's approval. (<a href="ProjectHome">More about joining a project</a>.) </p>

<p><br><br><A name="firsttimeusers"></A><SPAN class=HelptextHeader><b>For first-time users</b></SPAN></br>

<p><br><br><a name="before"></a><span class="HelptextHeader"><b>Before you join a project: what you can do</b></span><br>

<p>The natural place to start (and it is also the default) is the <a href="#StartPage">"My StartPage,"</a> which presents you with, among other things, a generous category list of currently hosted projects and a navigation bar on the left listing useful and important links. Each of these items is available for browsing. In fact, before you have even joined a project, you can:</p>
  
<ul>
<li>View category and project home pages</li>
<li>Read project news pages</li>
<li>Read the SourceCast <a href="DomainFAQ.html">FAQ</a> and <a href="TermsOfUse.html">Terms of Use</a> documents</li>
<li>Edit your user login ID and password</li>
<li>Download sample source code</li>
<li>Join project mailing lists</li>
<li>Propose your own project</li>
</ul>
<p>These items will be touched on throughout this document, as they are common to all users alike. Each item provides some insight either into the structure of SourceCast or into particular projects and their communities of developers. Investigating the categories, for instance, can give you a fair idea of the project at hand, as can reading the project news pages.</P>
<p><br><br><a name="aboutsubscribing"></a><span class="HelptextHeader"><b>About subscribing to project mailing lists</b></span></br>

<p>One of the best ways to learn not only about a particular project but get a feel for the community that is working on it, is to subscribe to the mailing lists associated with that project. You may even be able to post your own ideas for the project as a way of introducing yourself to the project team. However, your ability to subscribe to project mailing lists depends on the project's licensing. Most open-source projects will allow you to subscribe before actually joining the project, depending upon the project owner's preference. </p>

<p>In the case of proprietary projects, you may need approval to join the project at the most basic &quot;observer&quot; level before you can subscribe to any 
mailing lists. <a href="DomainDocsMailingLists">Read more about mailing lists</a>.</p>

<p><br><br><a name="after"></a><span class="HelptextHeader"><b>Once you join a project: what you can do</b></span></br>

<p>Part of the point of SourceCast is, of course, to encourage developers to join and create projects. Consequently, we have made the process as painless as possible; and we have provided some advantages. In fact, there are no disadvantages. Joining a project gives you the tools and the community to realize your goals. As a member of a project you can:</p>

<ul>
<li>Download source code</li>
<li>Upload files and documents</li>
<li>Participate in project mailing lists</li>
<li>Query and report project issues</li>
<li>Use other hosted  development tools like CVS versioning control. (<a href="DomainDocs">What are these tools?</a>)</li>
</ul>

<p>Your degree of access to files and your ability to do things depends upon the project's licensing (open source or proprietary) and your particular role in that project. (You can change your role; as a member, you can't change the project licensing.) <a href="#AboutProjectRoles">Later, we discuss the intricacies of project roles</a>.</p>

<p><br><br><a name="UserEdit"></a><span class="HelptextHeader"><b>About your user profile</b></span></br>

<p>Clicking the <B>Edit Profile</B> link in the upper right corner of your Start Page displays a screen where you can edit your profile, including your username and password for SourceCast, and your email address. Because SourceCast and the <!--  --> CollabNet developer site share the same user database, changing your username or password here also changes your developer login information.

<p>Once you become a member of any SourceCast development projects, the User Edit screen lists your roles with those projects. These are linked to enable you to navigate directly to the project's home page. Clicking on any hyperlinked project takes to that project, where you can change your role by clicking on "Request New Project Role."</p>
 
<p><br><br><a name="NavigatingWebspace"></a><span class="HelptextHeader"><b>Navigating SourceCast</b></span><br>

<p><br><br><a name="webspaceleftbar"></a><span class="HelptextHeader"><b>SourceCast: the left navigation bar</b></span></br>
<p>The discussion below explains the various tabs of the left navigation bar. The bar is a constant throughout SourceCast, and provides invaluable resources.</P>
<ul>
<li><b>My Start Page:</b> Clicking on this button from anywhere in SourceCast returns you to your customized start page.</li>
<li><b>Hosted Projects:</b> This page lists all projects hosted on this site, organized by category, with important details: project name, type of license, and a short description of what the project is about. Click on any project listed to visit the project's home page for more information.</li>
<li><b>Help:</b> A link to this help document you are currently reading.</li>
<li><b>Tool Docs:</b> Important documentation about how to use the tools necessary for managing and administering projects, filing issue reports, and more.</li>
<li><b>Site FAQ:</b> Basic questions and answers about this site.</li>
<li><b>Feedback:</b> A page where you can submit feedback on the SourceCast website and submit requests for technical support.</li>
<li><b>Logout:</b> Click here to log you out of SourceCast.
</ul>

<p><br><br><a name="StartPage"></a><span class="HelptextHeader"><b>My Start Page: sections</b></span></br>

<blockquote>
<b>My Projects</b><br>This list captures all SourceCast development projects in which you have a role.<br><br>
<b>Pending Requests</b><br>
Your pending activities are tracked here: projects awaiting approval, requests to join projects, and project documents you have agreed to review.<br><br>
<b>Hosted Project Categories</b><br>
All projects currently hosted on SourceCast are listed by category. Projects are grouped into categories according to development or application type. Thus, those projects dealing with games are associated together. As a result, you can quickly see what sort of projects are available in your areas of interest. Category names in this section link to category home pages, where projects are listed by individual name with short descriptions.
<a href="#ProjectCategoryHome">Read more about project categories</a>.  
</blockquote>

<p><hr size="1" noshade>

<p><a name="ProjectHelp"><span class="ProjectHeader">Project help: about joining and starting projects</span>

<p><br><br><A name="Joining"></A><SPAN class="HelptextHeader"></a><b>Joining a project</b></SPAN><br>
  
<p>As a registered user on SourceCast, you can go to any project's home page and see what's there. Likely as not, the project owner has made an effort to provide interesting material; in fact, it might be compelling enough to induce you to join. Joining projects (yes, you can join more than one) opens up greater access to the powerful features and development tools available to you on this site. The following section describes how to navigate this site to find information and join a project.</p>

<p><br><br><a name="Learning"></a><span class="HelptextHeader"><b>Learning about projects</b></span><br>

<p>Click on the <b>Projects</b> button on the left navigation bar. You will be taken to the Hosted Projects page, where all the projects are listed by category. View the listed projects; clicking on any takes you to that project's home page. 

<p><a name="ProjectCategoryHome"></A>You can also view lists of projects within a specific category using the <B>Project Category Home</B> page. To get there, choose a project category and click it. The Project Category Home page is where you can view all those projects sharing the same category. Project names on this page link to each project's home page.</p>
 
<p><A name="ProjectHome"></A>The <B>Project Home</B> page for any particular project is the project's focal point with information that the project owner wishes to share with members and nonmembers alike. Because project home pages can be customized, these vary greatly, depending on the project owner's preferences. At a minimum, the owner should include content describing the nature and goals of the project. Interested users can also use the project's hyperlinks in the Project Resources tool bar above to learn more about the project, including subscribing to that project's mailing lists.</a>.</p>

<p><br><br><a name="ProjectMembershipRequest"></A><span class="HelptextHeader"><b>Becoming a member</b></span></br>

<p>To request membership in a project, click <I>Join this Project</I> on the far right side of the screen in the <B>Project Home</B> page, which takes you to the <B>Project Membership Request</B> page. (If you are already a member of that project, the link changes to reflect your status.) The pull-down menu in the middle of the page presents you with several role options. Think of the roles as means to inform the project owner how you intend to contribute. You may request or even be asked to fulfill more than one role at some point, and you can certainly fulfill other roles on different projects.
</p>
<P>Depending on the project's configuration, you will receive email from the project owner approving or disapproving your project membership. Upon being approved, you will also receive more information about the nature of the particular module you will be working on.</p>

<p>Once you are a project member and your involvement progresses, you may wish to change your role in a project. The Project Home page includes a <I>Request New Project Role</I> link in the top right corner of the same page you originally used to request membership originally in the project. Now, however, your current role is noted in the top section, and only the remaining roles available to you are displayed with radio buttons. Again, you submit this change as a request that the project owner must approve.</P>

<p>As a project member, you are able to work with the full set of hosted tools. These include signing up for tasks, reporting issues using IssueZilla, and obtaining project source code using CVS. See specific pages for more information about these tools, and read the <A HREF="/DomainDocs">Tool Docs</A>.</p>
<p> 
<p><br><br><a name="ProjectRoles"></a><span class="HelptextHeader"><b>About project roles</b></span><br>

<blockquote>
<b>Observer</b><br> You have "read-only" access to most project pages, files, and documents. You can view and query project issues, browse project source code files, subscribe to project mailing lists and post messages, but you do not contribute directly to the project.

<p><b>Developer</b><br>
You gain read and write access to view and download <b>all</b> project pages, files, and documents. You can browse and checkout project source code files, and subscribe and post messages to project mailing lists. You query, report, and respond to project issues, and you can contribute code and patches.

<p><b>Content Developer</b><br>
You have read and write access to develop and manage a project's web content, including project news. You can also query, report, and respond to project issues, browse and checkout project source code files, and subscribe and post messages to project mailing lists.


<p><b>Project Owner</b><br>
You define the project's overall mission, direction, methodology, and community make-up. As owner, you can also reconfigure the project to address emerging concerns and control membership. You are also the default moderator of all project mailing lists.
</blockquote>

<p><br><br><A NAME="ProjectAdd"></A><SPAN CLASS="HelptextHeader"><b>Starting a new project</b></SPAN></a><br>
<p><br><br><A NAME="ProjectAddStep1"></A><span class="HelptextHeader"><b>Create a New Project (Step One): Naming and Describing your project</b></span><br>

<p>Say you want to create your own project. It's easy! But, all the same, you might want to read these instructions to get a sense of what you should do first--so that you don't have to redo it.</p>
<p>If you wish to start your own project, begin by defining the project's mission and goals. The process is fairly simple; however, you should probably come to the task prepared, with a good sense of what you want and how you want to accomplish it. Knowing whom to invite onto your project won't hurt, either. The <i>Start a project </i>link on the My Start Page (and several other pages) leads you through a three-step process to turn your idea into a pending project. Once you complete this process--and it doesn't take long--a special home page specific to your project is generated. Your project home page is the focal point for everything having to do with your project, and all registered users can view it. It is therefore important that you create a page that is as informative as it is inviting.</p>

<P><BLOCKQUOTE><a name="ProjectNameField"></A><B>Project Name</B><BR>
Enter what you wish to call your project. Choose a name that both describes the project and conforms to the naming conventions. That is, use the a-z, 0-9, and dash (but not as first character); no spaces, underscoring, capitalization, or other punctuation. Keep in mind that the project name cannot be changed. An example of a name for a project dealing with porting a sophisticated chess game to the telephone might be &quot;chessphone.&quot; Unimaginative, to be sure, but descriptive.</P>

<P><a name="SummaryField"></A><B>Summary</B><BR>
Enter a one-line description of your project, no longer than the field length. The description should be in plain text; HTML and formatted text are not supported. The description will be adjacent to the name of the project and be what registered users see first when they view the list of available projects. It should therefore be descriptive and concise. For instance, in the case of the chess game, you might write: &quot;Porting an advanced chess game to the phone.&quot; Unlike the project name, you can edit this field at any time.</P>

<P><a name="DescriptionField"></A><B>Description</B><BR>
This description makes up the bulk of your project's home page. It is where you can present the project in as interesting a light as possible. You can include HTML, formatted text, and so on, but keep in mind that most developers prefer simple and fast over complicated and slow (and confusing). State here your project's mission, background, methodology, tasks available, and other information that a developer might need to begin working on your project. This field can be edited at any time by clicking on the &quot;Edit Project&quot; link once you have finished creating a project, but the information should remain consistent.

<p><a name="URLAliasField"></A><B>URL Alias</B><BR>
You can choose either to have your project URL hosted through the SourceCast domain, a third party customer's domain, or directed to your own domain name (if you own one). In the latter two cases, you can direct the DNS entry to SourceCast as a virtual host, so your project's page requests are handled by SourceCast's servers. Otherwise, leave this entry blank. All projects are assigned a URL as: PROJECTNAME.[domainname].[com]. This feature can be edited later by clicking on the &quot;Edit Project&quot; link once you have finished.</P>
</BLOCKQUOTE></P>

<span class="PlainText">

<P><br><br><a name="ProjectAddStep2"></a><span class="HelptextHeader"><b>Create a New Project (Step 2): Choosing your project's license and profile</b></span><br>

<P><BLOCKQUOTE>

<P><a name="LicenseField"></A><B>License</B><BR>
Choose the license you wish to apply to the project. Licenses can range from the open source GPL to proprietary. Once your project is approved, you cannot switch from an open-source model to a proprietary one. However, proprietary projects can choose to go open source. To edit this feature of your project, you need to click on &quot;Edit Project&quot; link, once you have finished the process of creating the project. <a href="#TypicalLicenses">Read more about licenses.</a></p>

<P><a name="ProjectCategoryField"></A><B>Project Category</B><BR>
Select the category appropriate for your project. Because projects are listed by category in both the Start Page and Projects home pages, the choice of category is critical for giving developers a sense of the kind of work available. A developer who specializes in games, for example, will not necessarily want to view projects in the productivity category. As you can see, there are many possible options, and if you end up preferring another category, you can change your project category at any time. To edit this features of your project, click on &quot;Edit Project&quot; once you have finished creating the project.</p>
 
<P><a name="ProjectProfileField"></A><B>Project Profile</B><BR>
The Project Profile buttons are configured to automatically create mailing lists for your particular project. Perhaps you have a project idea that will require much discussion and input from other developers well before getting to the point of actual source code; this would be a "Discussion project." If your project, on the other hand, involves reworking existing source code, choose "Standard development project." Selecting a content project generates a standard mailing list; you would not have access to the issue-tracking system because it would not be necessary. Selecting the source code instance generates five mailing lists, and gives you access to all of the other resources of the site, including issue tracking. It is important to stress that no matter what profile you choose, you can change it later.</p>
</BLOCKQUOTE></P>

<span class="PlainText">

<p><br><br><a name="ProjectAddStep3"></a><span class="HelptextHeader"><b>Create New Project (Step 3): Inviting people to join your project</b></span><br> 


<P>Invite as many people as you wish by listing their email addresses, one email address per line, or multiple addresses if each address is separated by a comma, colon, or semicolon. Automatically generated invitations to each invitee will be sent; you can use the field below to include a personal message, perhaps a brief explanation of your project's purpose, why you think he or she might find it worthwhile to join in, and a link providing direct access to your project home page.</p>
<p>Recipients of your invitation who are already registered <!--  --> CollabNet developers log in to <!--  --> CollabNet's developer site to view your SourceCast project home page. To join your project, they click the &quot;Join This Project&quot; link.</p>
<p>If the person you're inviting is <i>not</i> a registered <!--  --> CollabNet developer, the email invitation asks her to register first as a <!--  --> CollabNet developer to obtain a login and password by email. Then this person is able to log in and view your SourceCast project home page.</p> 

<p>Recipients of your invitation who are already registered <!--  --> CollabNet developer's must log in to <!--  --> CollabNet's developer site before they can view your SourceCast project home page. If they wish to join your project, they can click the "Join This Project" link.

<p>If the person you're inviting is <I>not</I> a registered <!--  --> CollabNet developer, he/she is instructed by the email invitation to register first as a <!--  --> CollabNet developer to obtain a login and password by email. Then this person is able to log in and view your SourceCast project home page.

<P><blockquote><a name="InvitationMessageField"></A><B>Invitation Message</B><BR>
<span class="PlainText"><P>This message should be brief, but clear and informative. You can include hyperlinks, and any other information that you think would promote your project. Formatting and HTML are not, however, supported--the message, that is, stands on what it says not on how it looks. Hint: write out what you want to say beforehand. That way, you won't be lost for words. Finally, all the other project information is automatically generated, so you don't have to worry about including it again.</p></span>
</BLOCKQUOTE>
</P>

<span class="PlainText">

<p><br><br><a name="ProjectAddStep4"></a><span class="HelptextHeader"><b>Project creation confirmation</b></span><br>

<P>When you finish filling out all the fields and writing the messages, click <b>Finish,</b> which takes you to the confirmation page. From there, you can go to your newly created project home page.</p>

<P>While your project's status is pending, you can do many things to enhance your project's appeal. You can:</p>

<ul>
<li>Customize your project home page content</li>
<li>Add, configure, or delete mailing lists</li>
<li>Upload source files and documents</li>
<li>Invite additional participants</li>
</ul>

<p>In short, you can use most of the project functionality while waiting for project approval. Once your project is approved, you can accept member requests and solidify the community.</p>

<p><br><br><A name="ProjectEdit"></A><SPAN class="HelptextHeader"><b>Administrating the project</b></SPAN><br>

<p><br><br><a name="ProjectEdit"></a><span class="HelptextHeader"><b>Editing the project</b></span><br>

<P>All project configuration and management activities begin with the Administrate Project page. You access this page for your project in a couple of different ways:</p>

<UL>
<LI>In your My Start Page, your project appears under &quot;My Projects.&quot; Clicking on the project name takes you to the Project Home page where an &quot;Edit this project&quot; link appears in the top right corner.
<LI>You can also click the "Admin" link in the "My Projects" section of your Start Page. This link only appears with projects you own.
<LI>In all project pages, an "Admin" link appears in the Project Resources tool bar.
</UL> 

<P>You can edit your project here to change how project information is displayed in your project home page and project listings. Most of these fields mirror the fields in the project creation process: Project Name, Summary, Description, URL Alias, License, and Project Category. You can edit these fields as necessary, but basic project information should remain fairly constant.</p>

<p>Two new fields in this screen are: </p>

<p><br><br><a name="ownersmessage"></a><span class="HelptextHeader"><b>Owner's Message</b></span><br>

<p>Enter a brief message to be included in your project home page. Some of the ways to use this field may include: 
        <ul>
        <li>Identifying yourself as the project owner </li>
        <li>Giving brief project highlights, updates, or milestones </li>
        <li>Advertising your project's resource needs, for example: "Desperately seeking experienced Java servlet developers with a passion for creating apps that will change the world." Lame, perhaps, but you get the point.</li>
      </ul>

<p>In contrast to the project summary field on your project home page, the owner's message should tell more about the current status of development. This information should be regularly updated, say every week or at least monthly.</p>

<p><br><br><a name="projmailinglist"></a><span class="HelptextHeader"><b>Mailing Lists</b></span><br>

<p>Newly created source-code projects include a default set of five preconfigured lists. These cover the basics of development. You may choose to add additional lists using this <I>new</I> link to access the Mailing List Add page. To change how default project mailing lists are configured, use the <I>MailingLists</I> link in the Project Resources toolbar. 

<p><br><br><A name="AdminProjectResources"></A><SPAN class="HelptextHeader"><b>Project resources for administrators and members</b></SPAN><br>

<P>All registered users see the "Project Resources" toolbar at the top of project home pages. Although this tool bar always appears in every project page and provides access to project pages, the information displayed in those pages depends upon the user's status or role in a project.</P>

<UL>
<LI>Registered users who are not project members, do not see the "Members" link at all. Rather, they can view limited project information using other links in the tool bar.
<LI>Project members have more access based upon their roles.
<LI>Project owners see additional administrative options on each project page.
</UL>

<P><br><br><a name="ProjectHomePage"></a><span class="HelptextHeader"><B>Project Home page</B></span><br>

<P>This link always returns you to the project home page.  

<p><br><br><a name="ProjectNews"></a><span class="HelptextHeader"><B>Project News</B></span><br> 

<P>Links for project announcements, milestones, and articles appear on this page.

<a name="ProjectNewsAdd"></a>Project owners see a link in the top right corner to "Add a News Item." The Project News Add page features input fields for the heading and body of news items to appear in your Project News page. An additional publishing feature lets you specify dates to automate when each news document appears in the Project News screen and when it is archived.

<p><br><br><a name="ProjectDownload"></a><span class="HelptextHeader"><b>Project Download</b></span><br>

<P>Downloadable project files are displayed in the "Download" section. New files may be uploaded in the "Add or Replace a Download" section. Project members look here to download project specifications, files, and documents, or to contribute their own project documents. This screen contains no additional administrative features.

<P>To download a file from the project home page, click on the title of the file. The download should then commence immediately. 
<P>To upload a file, type in the URL and/or filename, or use the <I>Browse</I> button to select the file from your hard drive, then click the <I>Upload File</I> button. The upload will immediately commence.

<p><br><br><a name="ProjectMembers"></a><span class="HelptextHeader"><B>Project Members</B></span><br>

<P>All project members and their roles are listed here, with associated links to view project issues specifically assigned to each person. As the project owner, you (and any project participants you assign with an administrative role) can also see:

<UL>
<LI>A button to revoke membership roles
<LIA link to add new members
<LI>A section listing pending project membership requestors by name 
</UL>

<p><br><br><a name="ProjectMail"></A><span class="HelptextHeader"><B>Project Mailing Lists</B></span><br> 
<dl>
<dt>To subscribe:
<dd><li>If your mail client is configured for browswer-based mail, click on the hyperlinked mailing list address to which you want to subscribe.</li></dd>
<dd><li> If your mail client is not configured for browswer-based mail, simply copy the hyperlinked mailing list address and paste it into the "To" field in a new email message.</li></dd>
<dd><li> Send the message from your email client. You should receive a response asking for a confirmation.</li></dd>
<dd><li> Reply as indicated. You will receive an email welcoming you on your successful mailing list subscription.</li></dd>
</dl> 
<p>Unsubscribing is the same process, only instead of using the "subscribe" buttons or
addresses, you use "unsubscribe."</p>
<p>Once on the Mailing Lists page, you can view the project mailing list archives by clicking on the "view archive" link next to the mailing list title for that list. Click on the date range and subject links to specify the sort of messages you want to see.</p>
<P>All mailing lists associated with the project are listed here. The links on this page allow you to subscribe (or unsubscribe) to the available mailing lists. 

<p><br><br><a name="ProjectSource"></a><span class="HelptextHeader"><B>Project Source</B></span><br>

<P>You can either browse the source code online with a Web browser or check out source code files via CVS (command line). If you are unfamiliar with CVS, the page lists valuable sources for learning more about the protocols and use of CVS. You can also find information using the <A HREF="/DomainDocsCVS">Tool Docs</A> link in the left navigation bar.

<p><br><br><a name="ProjectIssues"></a><span class="HelptextHeader"><B>Project Issues</B></span><br>

<P>All project activities are tracked in an <A HREF="/DomainDocsIssues">issue database</A>. As used here, "Issue" is a term encompassing bugs, features, enhancements, tasks, and patches. An issue, that is, is a task. The advantage of using the issue tracker is that it keeps a file of those issues (including important specifications) you've agreed to take on. Issues can be reassigned.

<p><br><br><a name="ProjectAdmin"></a><span class="HelptextHeader"><B>Project Admin</B></span><br>

<P>This link always displays the <B>Project Edit</B> page. That is, by clicking on it you are immediately take to the page where you can edit (or administrate) your project.</p>

<hr size="1" noshade>

<a name="TypicalLicenses"></a><b><span class="ProjectHeader">Licenses</span></b>

<p><br><br><span class="HelptextHeader"><b>Software is controlled by copyright</b></span></p>

<p>Determining whether to license your project using one of the open-source licenses or whether to make your project proprietary is a difficult decision and should be taken only after the careful consideration of the consequences. Keep in mind that software is copyrighted. The software creator holds a copyright on the code, which allows the person or entity (it can be a corporation) to control how copies are made, for both source and binary forms. When the copyright holder sells a license to use the code, the copyright holder retains copyright but the licensee gains the legal right to use the code or compiled program in the manner dictated by the license. </p>

<p>Below, we have provided brief descriptions of the more commonly used open-source licenses. All of these open-source licenses share three central provisions:</p>
    
<ul>
      <li>Free redistribution (branded distribution can be sold) </li>
      <li>Source code must be publicly available </li>
      <li>No restrictions on making and distributing modifications </li>
</ul>

<p>We have also included the option of keeping the code proprietary, or closed source. The choice of open or closed source rests finally upon how you wish to configure project.

<p><br><br><br><a name="Public"></a><span class="HelptextHeader"><b>Public</b></span><br>

<a name="Apache"></a>

<p><b><A href="http://www.apache.org/LICENSE-1.1.txt">The Apache license</a></b><br>
The Apache license stipulates that any redistribution of the software include the text, "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." This is often called the "Acknowledgment Clause." The original BSD license had a similar clause as well, but it was removed in July of 1999. Having the clause promotes awareness of the product; removing it simplifies the act of redistribution. The Apache license also reworks the  BSD's third restriction into a pair of restrictions that protect the name "Apache" from being used as the name of a derived product or to endorse the derived product.

<a name="BSDStyleLicenses"></a>

<p><b><a href="http://www.opensource.org/licenses/bsd-license.html">The BSD license</a></b><br>
Developed by the University of California, Berkeley, the BSD license is the most unrestricted of the open-source licenses. It allows for use, modification, and redistribution subject to three simple restrictions (paraphrased): 

<ul>
<li>The files must retain their original copyright and license</li>
<li>Binary redistributions must include a copy of the copyright and license somewhere in the distribution</li>
<li>The names of the project creators and contributors may not be used to endorse products derived from the software without permission</li>
</ul>

It also includes a standard disclaimer of warranty.

<a name="GPL"></a>

<p><b><a href="http://www.gnu.org/copyleft/gpl.html">The GNU General Public License (GPL)</a></b><br>
The GNU GPL, created by <a href="http://www.fsf.org/">the Free Software Foundation</a>, was the first open-source license and, in its insistence on keeping source code free, it remains the strictest. In a nutshell, the GPL stipulates not only that all "free" code must remain "free," but that all code derived in part or in whole from such code must be fall under the same license terms as the original code. On the face of it, the license would seem to encourage nonprofit development and discourage commercial interests. However, as Brian Behlendorf has argued, the GPL can provide a vehicle for the widespread establishment of a platforms that indirectly enhance commercial interests.

<p><br><br><br><a name="Proprietary"></a><b><span class="HelptextHeader">Proprietary</a></b><br>

<p>It is by no means the case that the open-source method is always the best. You can, if you wish, keep your work closed source. This means that others cannot freely work on it without your express permission.
<p><b>Select open source references<b><br>
<ul>
<li> <a href="http://www.opensource.org/">The Open Source Initiative.</a> An open-source
advocacy group whose site houses useful links and information.</li>
<li> <a href="http://www.stromian.com/Open_Source_Licensing.htm">The Open Source Software
Licensing Page.</a> A very useful site listing open-source licenses, with links to the originals and sponsoring institutions or persons.</li>
<li> <a href="http://www.tuxedo.org/~esr/writings/cathedral-bazaar/">The Cathedral and the
Bazaar.</a> Eric Raymond's famous manifesto on open source. Required reading.</li>
<li><a href="http://user.cs.tu-berlin.de/~tron/opensource/"> An Introduction To Open Source
Software Development.</a> A comprehensive work by Steffen Evers describing open-source 
software development.</li>
</ul>

</span>@


1.1.1.1
log
@Replacing the HEAD with the HELM_PEER_PORT_BRANCH.
@
text
@@


1.1.4.1
log
@adding the generic, default docs into this branch, bc they are in the head and nec for instantiations using stable branches
@
text
@@

