Project Documents

Project resources for members: Index

Project resources for members
  Project Home Page
  Project News
  Project Files
  Project Members
  Project Mailing Lists
  You are here: Project Documents
  - About project documents
  - Viewing project documents
  - Contributing documents
  Project Source Code
  Project Issues

Back to main Help index

About project documents

A project's working files and documents are made available for viewing and sharing through the Project Documents page. These can be binary or other file format uploads, URLs, and HTML pages. Any working documents displayed here are under project version control.

Project documents are distinct from what you can find and download in the Project Files page. While either place may feature many different kinds of files and documents, the chief difference is that project documents are works in progress, whereas project files available for download are more or less finished products, the results of the project's efforts to date, and are not under version control.

Viewing project documents

Anyone can view working project documents for open source projects; you do not have to be a project member. Private project documents are restricted to project members, however.

To view project documents, from the Project Home page or any project page that displays the Project Resources toolbar, click the Documentation link. The Project Documents page displays files and documents organized by sections, much like an outline. Clicking on the document or filename link displays the contents in your browser window.

Contributing documents

If you are a member of a project, you can include files or documents in the Project Documents page by suggesting these to the Project Owner for his/her approval. You can also suggest new sections for organizing the Project Documents page. As a project member, your view of this page includes two links in the upper right corner: Suggest New Document and Suggest New Section.

Suggested documents should not exceed 25 MB in size. Documents larger than this cannot be uploaded.

Clicking Suggest New Document displays the Add Project Document page. Use the input fields in this page to enter the document name that will appear in the Project Documents page, a brief description, then select one of the three document options for submitting document:

- Locate the file by browsing your local machine directories
- Enter the URL for online documents
- Cut and paste the document's HTML content directly into a text box.

Choose which section the document should be placed in on the Project Documents page, or leave the default section selection, and click the "Add Document" button.

Until the Project Owner takes action, a link to your suggested document appears only in your view of the Project Documents page, but not to anyone else viewing this page. At any time, you can use the Edit link to modify the document title, description, or other fields, or you use the Delete link to remove the document.

If your suggested document is not approved, you will receive an email notification with the reason for this action.

Back to main Help index