Map of the general toolkit docs planned for GT4
Draft: 20 September 2004
Documentation applying to GT4 as a whole
- Release manuals
- Other release-related docs that apply to the toolkit in general
- Atomic fragments of content applying to the toolkit in general, for reuse in multiple docs
Please tell us what you think
If you wish to offer comments or suggestions regarding our documentation plans, please create a new bugzilla entry. Ideas for contributions are also welcome!
Release Manuals
| Top-Level GT Release Manuals | Purpose | Current Draft |
|---|---|---|
| Root of the 4.0 Release Manual [draft template] |
Serves as the root of the documentation tree for a stable release | Current draft |
| Key Concepts Manual [draft template] [bugzilla url here] |
Stable release documentation page that describes fundamental concepts applicable to all GT components | no draft yet available |
| Developer's Guide [draft template] |
Stable release documentation page that describes how to use the programming interfaces in GT (i.e., APIs, service interfaces, etc.) | no draft yet available |
| Sysadmin Guide [draft template] |
Stable release documentation page that describes general information for people who install, deploy and maintain GT installations | Current draft |
| User's Guide [draft template] |
Stable release guide to GT interfaces that support human-driven interactions, such as command-line tools, GUIs, etc. | Current draft |
Miscellaneous GT Release-Related Docs
| Other general GT docs in support of the release | Purpose | Current Draft |
|---|---|---|
| GT4 Fact Sheet | Describes Status and Plans for GT4 | Current Draft |
| Top-Level Release Notes for 4.0 Final [draft template] |
Describe implementation details of a new stable GT release to existing and potential users | Current Draft |
| 4.0 Final Software Download Page [draft template] |
Provide software download links for a stable release | no draft yet available |
| Software Download Survey Form [draft template] |
Gather information regarding downloads of GT distributions | no draft yet available |
| Guide to Testing GT Development Distributions | Provides background material and instructions targeted at internal and external testers of GT development distributions | no draft yet available |
| How to contribute tests to the GT test suite | Documents the steps for adding tests to the Globus test suite | no draft yet available |
| How to contribute code to the Globus Toolkit | Documents the steps for contributing code to the toolkit | no draft yet available |
| How to contribute documentation to the Globus Toolkit | Outlines the steps for contributing toolkit documentation | no draft yet available |
Reusable Fragments of Content Applying to GT in General
| General GT Docs | Purpose | Current Draft |
|---|---|---|
| Brief GT Overview Text Fragment |
Single paragraph that provides an overview of the Globus Toolkit for reuse across multiple docs | no draft available |
| 4.0 Component Overview Figure |
Figure containing the components currently planned for 4.0 | Current Draft (tiff) Current Draft (jpg) |
| GT Funding Acknowledgement Fragment | Fragment containing text acknowledging the funders of 4.0 | no draft available |
| 4.0 Contribution Acknowledgement Fragment | Fragment containing text acknowledging the work of contributors to 4.0 | no draft available |
