Project

General

Profile

Task #1001

Link documentation living with projects into ArchitectureDocs

Added by Roger Dahl almost 12 years ago. Updated almost 12 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Start date:
2010-10-21
Due date:
% Done:

0%

Milestone:
Product Version:
*
Story Points:
Sprint:

Description

Inside each of the following projects, there a documentation folder that contains stand-alone Sphinx documentation for that project. Need to integrate those with ArchitectureDocs.

  • GMN
  • Python DataONE CLI
  • d1common (Python)
  • D1 Python ITK

History

#1 Updated by Dave Vieglais almost 12 years ago

The individual projects should be kept as standalone documents that can be referenced from the architecture documentation. This is preferred to keep the size of the architecture docs to a more manageable size and retain their focus on architecture.

It may be necessary at some point in the future to generate an all-encompassing set of documents that includes operations, architecture, and documentation for specific components and applications.

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)