head	1.8;
access;
symbols
	TIGRIS_1_1_0RC2:1.2.6.1
	TIGRIS_1_1_0RC1:1.2.6.1
	TIGRIS_1_1:1.2.6.1.0.2
	TIGRIS_1_0_8:1.2.6.1
	TIGRIS_1_0_8RC3:1.2.6.1
	TIGRIS_1_0_8RC2:1.2.6.1
	TIGRIS_1_0_8RC1:1.2.6.1
	TIGRIS_1_0_7:1.2.6.1
	TIGRIS_1_0_7RC3:1.2.6.1
	TIGRIS_1_0_7RC2:1.2.6.1
	TIGRIS_1_0_7RC1:1.2.6.1
	TIGRIS_1_0_6:1.2.6.1
	TIGRIS_1_0_6RC5:1.2.6.1
	TIGRIS_1_0_6RC4:1.2.6.1
	TIGRIS_1_0_6RC3:1.2
	TIGRIS_1_0_6RC2:1.2
	TIGRIS_1_0_6RC1:1.2
	TIGRIS_1_0_5:1.2
	TIGRIS_1_0_5RC6:1.2
	TIGRIS_1_0_5RC5:1.2
	TIGRIS_1_0_5RC4:1.2
	TIGRIS_1_0_5RC3:1.2
	TIGRIS_1_0_5RC2:1.2
	TIGRIS_1_0_5RC1:1.2
	TIGRIS_1_0_4:1.2
	TIGRIS_1_0_3:1.2
	TIGRIS_1_0_2:1.2
	TIGRIS_1_0_1:1.2
	TIGRIS_1_0:1.2.0.6
	TIGRIS_1_0_0:1.2
	TIGRIS_1_0_0_RC1:1.2.0.2;
locks; strict;
comment	@# @;


1.8
date	2001.07.30.23.56.26;	author tberry;	state Exp;
branches;
next	1.7;

1.7
date	2001.06.21.07.07.40;	author jefflove;	state Exp;
branches;
next	1.6;

1.6
date	2001.06.11.03.14.33;	author jefflove;	state Exp;
branches;
next	1.5;

1.5
date	2001.05.21.23.51.02;	author lori;	state Exp;
branches;
next	1.4;

1.4
date	2001.05.21.23.41.10;	author lori;	state Exp;
branches;
next	1.3;

1.3
date	2001.03.29.06.00.08;	author lori;	state Exp;
branches;
next	1.2;

1.2
date	2001.03.12.08.21.55;	author lori;	state Exp;
branches
	1.2.6.1;
next	1.1;

1.1
date	2001.03.07.00.41.12;	author lori;	state Exp;
branches;
next	;

1.2.6.1
date	2001.06.13.00.35.21;	author lori;	state Exp;
branches;
next	;


desc
@@


1.8
log
@added info on folders nad new project document goodies

Issue number:
Obtained from:
Submitted by:
Reviewed by:
@
text
@  <div class="docs" id="projectownerdocuments">
   <h2>Managing project documentation</h2>

   <div class="toc">
    <h3>Project help for project owner administration: Index</h3>

    <ul>
     <li>
      <a href="ProjectOwnerAdmin.html">Project owner administration</a> 

      <ul>
       <li><a href="ProjectOwnerEdit.html">Editing and maintaining the Project Home page</a></li>

       <li><a href="ProjectOwnerNews.html">Managing project site news</a></li>

       <li><a href="ProjectOwnerFiles.html">Managing project files</a></li>

       <li><a href="ProjectOwnerMembers.html">Adding project members and approving roles</a></li>

       <li><a href="ProjectOwnerMailingLists.html">Configuring and managing project mailing lists</a></li>

       <li>
        <strong>You are here:</strong> Managing project documentation 

        <ul>
         <li><a href="#aboutdocs">About your project documentation</a></li>

         <li><a href="#adddocs">Adding/maintaining documents and sections</a></li>

         <li><a href="#approvedocs">Approving documentation suggestions</a></li>
        </ul>
       </li>

       <li><a href="ProjectOwnerSource.html">Managing project source code</a></li>

       <li><a href="ProjectOwnerIssues.html">Managing project issues and generating reports</a></li>
      </ul>
     </li>
    </ul>
   </div>

   <div class="courtesylinks">
    <p><a href="/servlets/HelpTOC">Back to the main Help index</a></p>
   </div>

   <h3><a id="aboutdocs" name="aboutdocs">About your project documentation</a></h3>

   
  <p>Either you or members of your project can make your project's documents available 
    for viewing and sharing through the <b>Project Documents List</b> page. These 
    can be binary or other file format uploads, URLs, and HTML pages. The documents 
    you include here come under your project's version control.</p>
  <p>Documents are organized in folders. Folders are organized in a tree hierarchy; 
    the parent folder at the top, with child folders beneath. The folder hierarchy 
    provides ease of organization of files. Thus, you may have a parent folder 
    entitled &quot;Test Scripts&quot; with child folders &quot;White Box Tests&quot; 
    and &quot;Black Box Tests&quot;, each containing documents relevant to their 
    folder name.</p>
  <p>The <b>Project Documents</b> page displays the folder hierarchy down three 
    levels; you are able to see the level you currently are in as well as it's 
    subfolders and their subfolders. When you select a subfolder it becomes your 
    current top level and you are presented with two levels of child folders beneath. 
    The folder description appears to the right of the folder name, and above 
    the list of documents contained within the folder. </p>
  <div class="docs" id="projectdocuments">
    <h3><a name="folders"></a>Creating Folders</h3>
    <p>To create a new folder:</p>
    </div>
  <ol>
    <li> 
      <div class="docs" id="projectdocuments"> From the Project Home page, select 
        the <b>Documents</b> link from the <b>Tools</b> bar.</div>
    </li>
    <li>Select the <b>Suggest a Folder</b> link from the <b>Tasks</b> bar.</li>
    <li>Enter a name in the <i>Folder Name</i> field. The folder name should be 
      short and descriptive of the content expected to be placed in this folder. 
      The <i>Folder Name</i> field will accept up to 125 characters, but you should 
      carefully consider the length of your folder name. If you feel the need 
      to further describe the folder to your end users you can use the <i>Optional 
      Description </i>field to enter a description of the type of content, up 
      to 240 characters in length. </li>
    <li>Click on the <b>Add Folder</b> button.</li>
  </ol>
  <h3><a id="adddocs" name="adddocs">Adding/maintaining documents and sections</a></h3>

   
  <p>You can add project documents by clicking <i>Add New Document</i> from the 
    <b>Tasks</b> bar displays the <b>Add Project Document</b> <b>to Folder</b> 
    page. Use the input fields on this page to describe the document that will 
    appear in this folder. To suggest a document enter the following information:</p>
  <div class="docs" id="projectdocuments"></div>
  <div class="docs" id="projectdocuments"> 
    <ul>
      <li> 
        <div class="docs" id="projectdocuments">Document Name: this should be 
          a short name for the document and cannot be more than 120 characters 
          in length. </div>
      </li>
      <li>Status: you must set your status as active or inactive.</li>
      <li>Description (optional): if you find that you would like to further describe 
        the file, use this field to add more information</li>
      <li>one or more of the following: 
        <ul>
          <li>File (can be made public): </li>
          <li>URL</li>
          <li>HTML content</li>
        </ul>
        <p>&nbsp;</p>
      </li>
    </ul>
    <p>Click on the <b>Add Document</b> button.</p>
  </div>
 


<p>If you need to update document information, move documents to different folders, 
    or remove documents altogether, use the <i>Edit</i> and <i>Delete</i> links 
    in the <b>Project Documents List</b> page. You may also rearrange the hierarchy 
    of documentation subsections you have created or delete sections altogether. 
    If a subsection you wish to delete contains documents, you can choose to delete 
    everything or move the documents to the top level.</p>
  <div class="docs" id="projectdocuments"></div>
  <h3><a id="approvedocs" name="approvedocs">Approving documentation suggestions</a></h3>

   <p>Project members can suggest documents and/or new sections for document organization, but these are not added to the <b>Project Documents List</b> page until you give your approval. Project members' view of this page features links to suggest new documents and sections.</p>

   <p>Suggested documents appear in the "Pending Actions" section of your <b>Start Page</b>. Both suggested documents and sections appear in your view of the <b>Project Documents List</b> page. The <i>Pending Approval</i> links adjacent to suggested documents/sections lead to the <b>Project Document Approval</b> page where you can approve, defer, or disapprove each item using the radio buttons. Then click the "Perform Actions" button to complete the task.</p>

   <p>The actions you take as Project Owner in response to suggested documents and sections automatically generate email notifications to the users who suggested the documents, and include instructions for them to contact you directly by email if they have further questions about your action. When you disapprove a suggested document, you are prompted to give the reason for your decision. This reason is included verbatim in the email notification to the user who suggested the document.</p>

   <p>For example, since the maximum document upload size is 25 MB per document, if one of your project members suggests a document that exceeds this limit, you can disapprove the document but also include a suggestion to break the document into smaller pieces to address this.</p>

   <div class="courtesylinks">
    <p><a href="/servlets/HelpTOC">Back to main Help index</a></p>
   </div>
  </div>
 


@


1.7
log
@html usage revision
@
text
@d1 139
a139 88
  <div class="docs" id="projectownerdocuments">
   <h2>Managing project documentation</h2>

   <div class="toc">
    <h3>Project help for project owner administration: Index</h3>

    <ul>
     <li>
      <a href="ProjectOwnerAdmin.html">Project owner administration</a> 

      <ul>
       <li><a href="ProjectOwnerEdit.html">Editing and maintaining the Project Home page</a></li>

       <li><a href="ProjectOwnerNews.html">Managing project site news</a></li>

       <li><a href="ProjectOwnerFiles.html">Managing project files</a></li>

       <li><a href="ProjectOwnerMembers.html">Adding project members and approving roles</a></li>

       <li><a href="ProjectOwnerMailingLists.html">Configuring and managing project mailing lists</a></li>

       <li>
        <strong>You are here:</strong> Managing project documentation 

        <ul>
         <li><a href="#aboutdocs">About your project documentation</a></li>

         <li><a href="#adddocs">Adding/maintaining documents and sections</a></li>

         <li><a href="#approvedocs">Approving documentation suggestions</a></li>
        </ul>
       </li>

       <li><a href="ProjectOwnerSource.html">Managing project source code</a></li>

       <li><a href="ProjectOwnerIssues.html">Managing project issues and generating reports</a></li>
      </ul>
     </li>
    </ul>
   </div>

   <div class="courtesylinks">
    <p><a href="/servlets/HelpTOC">Back to the main Help index</a></p>
   </div>

   <h3><a id="aboutdocs" name="aboutdocs">About your project documentation</a></h3>

   <p>Either you or members of your project can make your project's working documents available for viewing and sharing through the <b>Project Documents List</b> page. These can be binary or other file format uploads, URLs, and HTML pages. The documents you include here come under your project's version control.</p>

   <p>Project documentation is meant to be distinct from files available through the <b>Project Files</b> page. Both features let you publish a variety of files and documents, but project documentation is intended to organize works in progress. Project files, on the other hand, should reflect any finished work being made available for download, the results of your project's efforts to date.</p>

   <h3><a id="adddocs" name="adddocs">Adding/maintaining documents and sections</a></h3>

   <p>You can add projects documents by clicking <i>Add New Document</i> link to display the <b>Add Project Document</b> page. Use the input fields in this page to enter the document name that will appear in the <b>Project Documents</b> page, a brief description of the document, then select one of the three document options for submitting document:</p>

   <ul>
    <li>Locate the file by browsing your local machine directories</li>

    <li>Enter the URL for online documents</li>

    <li>Cut and paste the document's HTML content directly into a text box.</li>
   </ul>

   <p>The maximum size allowed for each uploaded document is 25 MB. Documents larger than this cannot be accepted. If you have a document to add that is larger than 25 MB, consider breaking into two or more smaller files.</p>

   <p>Choose which section the document should be placed in on the Project Documents p age or leave the default selection of "none" which places the document at the to p level. Finally, click the "Add Document" button.</p>

   <p>If you want to create a new section, click the <i>Add New Section</i> link in the top right corner of the <b>Project Documents List</b> page to display the <b>Add a Document Section</b> page. Here you may create a new section, enter a description of it, and designate its place within your project's documentation hierarchy. However, document subsections can only be created two levels deep.</p>

   <p>If you need to update document information, move documents to different sections, or remove documents altogether, use the <i>Edit</i> and <i>Delete</i> links in the <b>Project Documents List</b> page. You may also rearrange the hierarchy of documentation subsections you have created or delete sections altogether. If a subsection you wish to delete contains documents, you can choose to delete everything or move the documents to the top level.</p>

   <h3><a id="approvedocs" name="approvedocs">Approving documentation suggestions</a></h3>

   <p>Project members can suggest documents and/or new sections for document organization, but these are not added to the <b>Project Documents List</b> page until you give your approval. Project members' view of this page features links to suggest new documents and sections.</p>

   <p>Suggested documents appear in the "Pending Actions" section of your <b>Start Page</b>. Both suggested documents and sections appear in your view of the <b>Project Documents List</b> page. The <i>Pending Approval</i> links adjacent to suggested documents/sections lead to the <b>Project Document Approval</b> page where you can approve, defer, or disapprove each item using the radio buttons. Then click the "Perform Actions" button to complete the task.</p>

   <p>The actions you take as Project Owner in response to suggested documents and sections automatically generate email notifications to the users who suggested the documents, and include instructions for them to contact you directly by email if they have further questions about your action. When you disapprove a suggested document, you are prompted to give the reason for your decision. This reason is included verbatim in the email notification to the user who suggested the document.</p>

   <p>For example, since the maximum document upload size is 25 MB per document, if one of your project members suggests a document that exceeds this limit, you can disapprove the document but also include a suggestion to break the document into smaller pieces to address this.</p>

   <div class="courtesylinks">
    <p><a href="/servlets/HelpTOC">Back to main Help index</a></p>
   </div>
  </div>
 


@


1.6
log
@extensive markup rework - first pass toward house xhtmlification
@
text
@d1 2
a2 9
<!DOCTYPE html PUBLIC "-//CollabNet//DTD XHTML 1.0 Transitional//EN"
"http://collabnet.com/dtds/collabnet_transitional_10.dtd">
<html>
 <head>
  <title>Managing project documentation</title>
<style type="text/css">
 div.c1 {margin-left: 2em}
</style>
 </head>
d4 2
a5 3
 <body>
  <div class="docs" id="docid">
<h2>Managing project documentation</h2> 
d7 3
a9 1
  <p><b>Project help for project owner administration: Index</b></p>
d11 2
a12 1
  
d14 1
a14 3
  <div>
   <dl>
    <dt><a href="ProjectOwnerAdmin.html">Project owner administration</a></dt>
d16 1
a16 1
    <dd><a href="ProjectOwnerEdit.html">Editing and maintaining the Project Home page</a></dd>
d18 1
a18 1
    <dd><a href="ProjectOwnerNews.html">Managing project site news</a></dd>
d20 1
a20 1
    <dd><a href="ProjectOwnerFiles.html">Managing project files</a></dd>
d22 2
a23 1
    <dd><a href="ProjectOwnerMembers.html">Adding project members and approving roles</a></dd>
d25 2
a26 1
    <dd><a href="ProjectOwnerMailingLists.html">Configuring and managing project mailing lists</a></dd>
d28 1
a28 2
    <dd>
     <b>You are here: Managing project documentation</b>
d30 3
a32 2
     <ul>
      <li><b><a href="#aboutdocs">About your project documentation</a></b></li>
d34 1
a34 1
      <li><b><a href="#adddocs">Adding/maintaining documents and sections</a></b></li>
d36 5
a40 3
      <li><b><a href="#approvedocs">Approving documentation suggestions</a></b></li>
     </ul>
    </dd>
d42 3
a44 1
    <dd><a href="ProjectOwnerSource.html">Managing project source code</a></dd>
d46 1
a46 1
    <dd><a href="ProjectOwnerIssues.html">Managing project issues and generating reports</a></dd>
d48 1
a48 5
    <dt><a href="/servlets/HelpTOC">Back to the main Help index</a></dt>
   </dl>
  </div>
  
  <h3><a id="aboutdocs" name="aboutdocs">About your project documentation</a></h3> 
d50 1
a50 1
  <p>Either you or members of your project can make your project's working documents available for viewing and sharing through the <b>Project Documents List</b> page. These can be binary or other file format uploads, URLs, and HTML pages. The documents you include here come under your project's version control.</p>
d52 1
a52 1
  <p>Project documentation is meant to be distinct from files available through the <b>Project Files</b> page. Both features let you publish a variety of files and documents, but project documentation is intended to organize works in progress. Project files, on the other hand, should reflect any finished work being made available for download, the results of your project's efforts to date.</p>
d54 1
a54 3
  
  
  <h3><a id="adddocs" name="adddocs">Adding/maintaining documents and sections</a></h3> 
d56 2
a57 1
  <p>You can add projects documents by clicking <i>Add New Document</i> link to display the <b>Add Project Document</b> page. Use the input fields in this page to enter the document name that will appear in the <b>Project Documents</b> page, a brief description of the document, then select one of the three document options for submitting document:</p>
d59 1
a59 2
  <ul>
   <li>Locate the file by browsing your local machine directories</li>
d61 2
a62 1
   <li>Enter the URL for online documents</li>
d64 1
a64 2
   <li>Cut and paste the document's HTML content directly into a text box.</li>
  </ul>
d66 1
a66 1
  <p>The maximum size allowed for each uploaded document is 25 MB. Documents larger than this cannot be accepted. If you have a document to add that is larger than 25 MB, consider breaking into two or more smaller files.</p>
d68 1
a68 1
  <p>Choose which section the document should be placed in on the Project Documents p age or leave the default selection of "none" which places the document at the to p level. Finally, click the "Add Document" button.</p>
d70 1
a70 1
  <p>If you want to create a new section, click the <i>Add New Section</i> link in the top right corner of the <b>Project Documents List</b> page to display the <b>Add a Document Section</b> page. Here you may create a new section, enter a description of it, and designate its place within your project's documentation hierarchy. However, document subsections can only be created two levels deep.</p>
d72 1
a72 1
  <p>If you need to update document information, move documents to different sections, or remove documents altogether, use the <i>Edit</i> and <i>Delete</i> links in the <b>Project Documents List</b> page. You may also rearrange the hierarchy of documentation subsections you have created or delete sections altogether. If a subsection you wish to delete contains documents, you can choose to delete everything or move the documents to the top level.</p>
d74 1
a74 3
  
  
  <h3><a id="approvedocs" name="approvedocs">Approving documentation suggestions</a></h3> 
d76 1
a76 1
  <p>Project members can suggest documents and/or new sections for document organization, but these are not added to the <b>Project Documents List</b> page until you give your approval. Project members' view of this page features links to suggest new documents and sections.</p>
d78 1
a78 1
  <p>Suggested documents appear in the "Pending Actions" section of your <b>Start Page</b>. Both suggested documents and sections appear in your view of the <b>Project Documents List</b> page. The <i>Pending Approval</i> links adjacent to suggested documents/sections lead to the <b>Project Document Approval</b> page where you can approve, defer, or disapprove each item using the radio buttons. Then click the "Perform Actions" button to complete the task.</p>
d80 1
a80 1
  <p>The actions you take as Project Owner in response to suggested documents and sections automatically generate email notifications to the users who suggested the documents, and include instructions for them to contact you directly by email if they have further questions about your action. When you disapprove a suggested document, you are prompted to give the reason for your decision. This reason is included verbatim in the email notification to the user who suggested the document.</p>
d82 5
a86 6
  <p>For example, since the maximum document upload size is 25 MB per document, if one of your project members suggests a document that exceeds this limit, you can disapprove the document but also include a suggestion to break the document into smaller pieces to address this.</p>
  
<div class="courtesylinks"><a href="/servlets/HelpTOC">Back to main Help index</a></div> 
 </div>
</body>
</html>
@


1.5
log
@added info about doc subsections only allowed to 2 levels deep; issue 3895
@
text
@d1 2
d4 6
a9 1
<head>
d11 3
a13 1
<title>Managing project documentation</title>
d15 1
a15 76
</head>
<body>
<span class="HEADER">Managing project documentation</span>
<p>
<span class="PlainText"><b>Project help for project owner administration: Index</b>
<p>

<ul>
<dl>
<dt><a href="ProjectOwnerAdmin.html">Project owner administration</a>
	<dd><a href="ProjectOwnerEdit.html">Editing and maintaining the Project Home page</a>
	<dd><a href="ProjectOwnerNews.html">Managing project site news</a>
	<dd><a href="ProjectOwnerFiles.html">Managing project files</a>
	<dd><a href="ProjectOwnerMembers.html">Adding project members and approving roles</a>
	<dd><a href="ProjectOwnerMailingLists.html">Configuring and managing project mailing lists</a>
	<dd><b>You are here: Managing project documentation
		<ul>
		<li><a href="#aboutdocs">About your project documentation</a>
		<li><a href="#adddocs">Adding/maintaining documents and sections</a>
		<li><a href="#approvedocs">Approving documentation suggestions</a>
		</ul></b>
	<dd><a href="ProjectOwnerSource.html">Managing project source code</a>
	<dd><a href="ProjectOwnerIssues.html">Managing project issues and generating reports</a>
<dt><a href="/servlets/HelpTOC">Back to the main Help index</a>
</dl>
</ul>

<p>
<hr noshade size=1>
<a name="aboutdocs"></a><span class="InputHeader">About your project documentation</span>

<p>
Either you or members of your project can make your project's working documents available for viewing and sharing through the <b>Project Documents List</b> page. These can be binary or other file format uploads, URLs, and HTML pages. The documents you include here come under your project's version control.
<p>
Project documentation is meant to be distinct from files available through the <b>Project Files</b> page. Both features let you publish a variety of files and documents, but project documentation is intended to organize works in progress. Project files, on the other hand, should reflect any finished work being made available for download, the results of your project's efforts to date. 
<p>

<hr noshade size=1>
<a name="adddocs"></a><span class="InputHeader">Adding/maintaining documents and sections</span>

<p>
You can add projects documents by clicking <i>Add New Document</i> link to display the <b>Add Project Document</b> page. Use the input fields in this page to enter the document name that will appear in the <b>Project Documents</b> page, a brief description of the document, then select one of the three document options for submitting document:
<ul>
<li>Locate the file by browsing your local machine directories
<li>Enter the URL for online documents
<li>Cut and paste the document's HTML content directly into a text box.
</ul>
<p>
The maximum size allowed for each uploaded document is 25 MB. Documents larger than this cannot be accepted. If you have a document to add that is larger than 25 MB, consider breaking into two or more smaller files. 
<p>
Choose which section the document should be placed in on the Project Documents p
age or leave the default selection of "none" which places the document at the to
p level. Finally, click the "Add Document" button.
<p>
If you want to create a new section, click the <i>Add New Section</i> link in the top right corner of the <b>Project Documents List</b> page to display the <b>Add a Document Section</b> page. Here you may create a new section, enter a description of it, and designate its place within your project's documentation hierarchy. However, document subsections can only be created two levels deep.
<p>
If you need to update document information, move documents to different sections, or remove documents altogether, use the <i>Edit</i> and <i>Delete</i> links in the <b>Project Documents List</b> page. You may also rearrange the hierarchy of documentation subsections you have created or delete sections altogether. If a subsection you wish to delete contains documents, you can choose to delete everything or move the documents to the top level. 
<p>



<hr noshade size=1>
<a name="approvedocs"></a><span class="InputHeader">Approving documentation suggestions</span>

<p>
Project members can suggest documents and/or new sections for document organization, but these are not added to the <b>Project Documents List</b> page until you give your approval. Project members' view of this page features links to suggest new documents and sections.
<p>
Suggested documents appear in the "Pending Actions" section of your <b>Start Page</b>. Both suggested documents and sections appear in your view of the <b>Project Documents List</b> page. The <i>Pending Approval</i> links adjacent to suggested documents/sections lead to the <b>Project Document Approval</b> page where you can approve, defer, or disapprove each item using the radio buttons. Then click the "Perform Actions" button to complete the task.
<p>
The actions you take as Project Owner in response to suggested documents and sections automatically generate email notifications to the users who suggested the documents, and include instructions for them to contact you directly by email if they have further questions about your action. When you disapprove a suggested document, you are prompted to give the reason for your decision. This reason is included verbatim in the email notification to the user who suggested the document.
<p>
For example, since the maximum document upload size is 25 MB per document, if one of your project members suggests a document that exceeds this limit, you can disapprove the document but also include a suggestion to break the document into smaller pieces to address this.

<p>
<hr noshade size=1>
<a href="/servlets/HelpTOC">Back to main Help index</a>
d17 78
a94 1
</span>
d97 2
@


1.4
log
@added content about maximum file upload sizeof 25 MB per file; issue 3459
@
text
@d24 1
a24 1
		<li><a href="#adddocs">Adding new documentation</a>
d44 1
a44 1
<a name="adddocs"></a><span class="InputHeader">Adding and maintaining documentation</span>
d60 1
a60 1
If you want to create a new section, click the <i>Add New Section</i> link in the top right corner of the <b>Project Documents List</b> page to display the <b>Add a Document Section</b> page. Here you may create a new section, enter a description of it, and designate its place within your project's documentation hierarchy.
@


1.3
log
@made html tags lower case; added info about document disapproval
@
text
@d54 5
a58 1
Choose which section the document should be placed in on the Project Documents page or leave the default selection of "none" which places the document at the top level. Finally, click the "Add Document" button.
d77 1
d79 1
@


1.2
log
@change page name references to Project Documents List; fixed info about deleting sections and documents
@
text
@d1 2
a2 2
<HTML>
<HEAD>
d4 1
a4 1
<TITLE>Managing project documentation</TITLE>
d6 48
a53 48
</HEAD>
<BODY>
<SPAN CLASS="HEADER">Managing project documentation</SPAN>
<P>
<SPAN CLASS="PlainText"><B>Project help for project owner administration: Index</B>
<P>

<UL>
<DL>
<DT><A HREF="ProjectOwnerAdmin.html">Project owner administration</A>
	<DD><A HREF="ProjectOwnerEdit.html">Editing and maintaining the Project Home page</A>
	<DD><A HREF="ProjectOwnerNews.html">Managing project site news</A>
	<DD><A HREF="ProjectOwnerFiles.html">Managing project files</A>
	<DD><A HREF="ProjectOwnerMembers.html">Adding project members and approving roles</A>
	<DD><A HREF="ProjectOwnerMailingLists.html">Configuring and managing project mailing lists</A>
	<DD><B>You are here: Managing project documentation
		<UL>
		<LI><A HREF="#aboutdocs">About your project documentation</A>
		<LI><A HREF="#adddocs">Adding new documentation</A>
		<LI><A HREF="#approvedocs">Approving documentation suggestions</A>
		</UL></B>
	<DD><A HREF="ProjectOwnerSource.html">Managing project source code</A>
	<DD><A HREF="ProjectOwnerIssues.html">Managing project issues and generating reports</A>
<DT><A HREF="/servlets/HelpTOC">Back to the main Help index</A>
</DL>
</UL>

<P>
<HR noShade SIZE=1>
<A NAME="aboutdocs"></A><SPAN CLASS="InputHeader">About your project documentation</SPAN>

<P>
Either you or members of your project can make your project's working documents available for viewing and sharing through the <B>Project Documents List</B> page. These can be binary or other file format uploads, URLs, and HTML pages. The documents you include here come under your project's version control.
<P>
Project documentation is meant to be distinct from files available through the <B>Project Files</B> page. Both features let you publish a variety of files and documents, but project documentation is intended to organize works in progress. Project files, on the other hand, should reflect any finished work being made available for download, the results of your project's efforts to date. 
<P>

<HR noShade SIZE=1>
<A NAME="adddocs"></A><SPAN CLASS="InputHeader">Adding and maintaining documentation</SPAN>

<P>
You can add projects documents by clicking <I>Add New Document</I> link to display the <B>Add Project Document</B> page. Use the input fields in this page to enter the document name that will appear in the <B>Project Documents</B> page, a brief description of the document, then select one of the three document options for submitting document:
<UL>
<LI>Locate the file by browsing your local machine directories
<LI>Enter the URL for online documents
<LI>Cut and paste the document's HTML content directly into a text box.
</UL>
<P>
d55 5
a59 5
<P>
If you want to create a new section, click the <I>Add New Section</I> link in the top right corner of the <B>Project Documents List</B> page to display the <B>Add a Document Section</B> page. Here you may create a new section, enter a description of it, and designate its place within your project's documentation hierarchy.
<P>
If you need to update document information, move documents to different sections, or remove documents altogether, use the <I>Edit</I> and <I>Delete</I> links in the <B>Project Documents List</B> page. You may also rearrange the hierarchy of documentation subsections you have created or delete sections altogether. If a subsection you wish to delete contains documents, you can choose to delete everything or move the documents to the top level. 
<P>
d63 17
a79 17
<HR noShade SIZE=1>
<A NAME="approvedocs"></A><SPAN CLASS="InputHeader">Approving documentation suggestions</SPAN>

<P>
Project members can suggest documents and/or new sections for document organization, but these are not added to the <B>Project Documents List</B> page until you give your approval. Project members' view of this page features links to suggest new documents and sections.
<P>
Suggested documents appear in the "Pending Actions" section of your <B>Start Page</B>. Both suggested documents and sections appear in your view of the <B>Project Documents List</B> page. The <I>Pending Approval</I> links adjacent to suggested documents/sections lead to the <B>Project Document Approval</B> page where you can approve, defer, or disapprove each item using the radio buttons. Then click the "Perform Actions" button to complete the task.
<P>
The actions you take as Project Owner in response to suggested documents and sections automatically generate email notifications to the suggestors, and include instructions for them to contact you directly by email if they have further questions about your action.
<P>

<HR NOSHADE SIZE=1>
<A HREF="/servlets/HelpTOC">Back to main Help index</A>

</SPAN>
</BODY>
</HTML>
@


1.2.6.1
log
@updating branch with latest help files
@
text
@d1 2
a2 2
<html>
<head>
d4 1
a4 1
<title>Managing project documentation</title>
d6 74
a79 77
</head>
<body>
<span class="HEADER">Managing project documentation</span>
<p>
<span class="PlainText"><b>Project help for project owner administration: Index</b>
<p>

<ul>
<dl>
<dt><a href="ProjectOwnerAdmin.html">Project owner administration</a>
	<dd><a href="ProjectOwnerEdit.html">Editing and maintaining the Project Home page</a>
	<dd><a href="ProjectOwnerNews.html">Managing project site news</a>
	<dd><a href="ProjectOwnerFiles.html">Managing project files</a>
	<dd><a href="ProjectOwnerMembers.html">Adding project members and approving roles</a>
	<dd><a href="ProjectOwnerMailingLists.html">Configuring and managing project mailing lists</a>
	<dd><b>You are here: Managing project documentation
		<ul>
		<li><a href="#aboutdocs">About your project documentation</a>
		<li><a href="#adddocs">Adding/maintaining documents and sections</a>
		<li><a href="#approvedocs">Approving documentation suggestions</a>
		</ul></b>
	<dd><a href="ProjectOwnerSource.html">Managing project source code</a>
	<dd><a href="ProjectOwnerIssues.html">Managing project issues and generating reports</a>
<dt><a href="/servlets/HelpTOC">Back to the main Help index</a>
</dl>
</ul>

<p>
<hr noshade size=1>
<a name="aboutdocs"></a><span class="InputHeader">About your project documentation</span>

<p>
Either you or members of your project can make your project's working documents available for viewing and sharing through the <b>Project Documents List</b> page. These can be binary or other file format uploads, URLs, and HTML pages. The documents you include here come under your project's version control.
<p>
Project documentation is meant to be distinct from files available through the <b>Project Files</b> page. Both features let you publish a variety of files and documents, but project documentation is intended to organize works in progress. Project files, on the other hand, should reflect any finished work being made available for download, the results of your project's efforts to date. 
<p>

<hr noshade size=1>
<a name="adddocs"></a><span class="InputHeader">Adding/maintaining documents and sections</span>

<p>
You can add projects documents by clicking <i>Add New Document</i> link to display the <b>Add Project Document</b> page. Use the input fields in this page to enter the document name that will appear in the <b>Project Documents</b> page, a brief description of the document, then select one of the three document options for submitting document:
<ul>
<li>Locate the file by browsing your local machine directories
<li>Enter the URL for online documents
<li>Cut and paste the document's HTML content directly into a text box.
</ul>
<p>
The maximum size allowed for each uploaded document is 25 MB. Documents larger than this cannot be accepted. If you have a document to add that is larger than 25 MB, consider breaking into two or more smaller files. 
<p>
Choose which section the document should be placed in on the Project Documents page or leave the default selection of "none" which places the document at the top level. Finally, click the "Add Document" button. <p>
If you want to create a new section, click the <i>Add New Section</i> link in the top right corner of the <b>Project Documents List</b> page to display the <b>Add a Document Section</b> page. Here you may create a new section, enter a description of it, and designate its place within your project's documentation hierarchy. However, document subsections can only be created two levels deep.
<p>
If you need to update document information, move documents to different sections, or remove documents altogether, use the <i>Edit</i> and <i>Delete</i> links in the <b>Project Documents List</b> page. You may also rearrange the hierarchy of documentation subsections you have created or delete sections altogether. If a subsection you wish to delete contains documents, you can choose to delete everything or move the documents to the top level. 
<p>



<hr noshade size=1>
<a name="approvedocs"></a><span class="InputHeader">Approving documentation suggestions</span>

<p>
Project members can suggest documents and/or new sections for document organization, but these are not added to the <b>Project Documents List</b> page until you give your approval. Project members' view of this page features links to suggest new documents and sections.
<p>
Suggested documents appear in the "Pending Actions" section of your <b>Start Page</b>. Both suggested documents and sections appear in your view of the <b>Project Documents List</b> page. The <i>Pending Approval</i> links adjacent to suggested documents/sections lead to the <b>Project Document Approval</b> page where you can approve, defer, or disapprove each item using the radio buttons. Then click the "Perform Actions" button to complete the task.
<p>
The actions you take as Project Owner in response to suggested documents and sections automatically generate email notifications to the users who suggested the documents, and include instructions for them to contact you directly by email if they have further questions about your action. When you disapprove a suggested document, you are prompted to give the reason for your decision. This reason is included verbatim in the email notification to the user who suggested the document.
<p>
For example, since the maximum document upload size is 25 MB per document, if one of your project members suggests a document that exceeds this limit, you can disapprove the document but also include a suggestion to break the document into smaller pieces to address this.

<p>
<hr noshade size=1>
<a href="/servlets/HelpTOC">Back to main Help index</a>

</span>
</body>
</html>
@


1.1
log
@initial revision for 1.0 release
@
text
@a7 2
<TABLE BORDER="0" CELLSPACING="1" CELLPADDING="3" BORDER="0" WIDTH="100%">
  <TR>
d38 1
a38 1
Either you or members of your project can make your project's working documents available for viewing and sharing through the <B>Project Documents</B> page. These can be binary or other file format uploads, URLs, and HTML pages. The documents you include here come under your project's version control.
d40 1
a40 1
Project documentation is meant to be distinct from files available through the <B>Project Files</B> page. Both features let you publish a variety of files and documents, but project documentation is intended to organize works in progress, which is the reason these are under version control. Project files, on the other hand, should reflect any finished work being made available for download, the results of your project's efforts to date. Project files are not under version control.
d56 1
a56 1
If you want to create a new section, click the <I>Add New Section</I> link in the top right corner of the <B>Project Documentation</B> page to display the <B>Add a Document Section</B> page. Here you may create a new section, enter a description of it, and designate its place within your project's documentation hierarchy.
d58 1
a58 1
If you need to update document information, move documents to different sections, or remove documents altogether, use the <I>Edit</I> and <I>Delete</I> links in the <B>Project Documents</B> page. You may also rearrange the hierarchy of documentation subsections you have created or delete sections altogether. If a subsection you wish to delete contains documents, these are also deleted? | are automatically moved up a section level?
d67 1
a67 1
Project members can suggest documents and/or new sections for document organization, but these are not added to the <B>Project Documentation</B> page until you give your approval. Project members' view of this page features links to suggest new documents and sections.
d69 1
a69 1
Suggested documents appear in the "Pending Actions" section of your <B>Start Page</B>. Both suggested documents and sections appear in your view of the <B>Project Documentation</B> page. The <I>Pending Approval</I> links adjacent to suggested documents/sections lead to the <B>Project Document Approval</B> page where you can approve, defer, or disapprove each item using the radio buttons. Then click the "Perform Actions" button to complete the task.
a77 2
</TR>
</TABLE>
@

