Project

General

Profile

Story #3677

automate the build and publication of documentation for APIs and software

Added by Matthew Jones over 8 years ago. Updated almost 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
2013-08-26
Due date:
2014-09-24
% Done:

100%

Story Points:
Sprint:

Description

The current architecture documentation and javadocs that are published on mule1 only represent the HEAD/Trunk of development, and not the released versions of APIs and software. MN developers and ITK developers that want their software to work with current and prior versioned releases have no place to view this documentation. This story encompasses creating:

1) build systems that automate the production of architecture and javadocs for each released version using hudson
2) a standard URL for released versions of documentation
-- I suggest that released versions of documentation should be published to https://releases.dataone.org in the appropriate subdirectories (an online browsable version in 'online')

For example, for the R client release documentation, we have published:

@https://releases.dataone.org
/dist/dataone_1.0.0-manual.pdf
/online/dataone_r/index.html (overview page for product, with browsable links to documentation for current and prior released versions)
@

I think we should do something similar for libclient, common, architecture, etc. Need to add individual tasks to this story for completing this for each of our products.


Subtasks

Task #3949: create javadoc location for published docs on releases siteClosedMatthew Jones

History

#1 Updated by Matthew Jones over 8 years ago

  • Due date set to 2013-03-30
  • Target version set to 2013.12-Block.2.2
  • Start date set to 2013-03-17

#2 Updated by Dave Vieglais over 8 years ago

  • Target version changed from 2013.12-Block.2.2 to 2013.33-Block.4.4
  • Due date changed from 2013-03-30 to 2013-08-24

#3 Updated by Dave Vieglais over 8 years ago

  • Status changed from New to In Progress

#4 Updated by Dave Vieglais almost 8 years ago

  • Due date changed from 2013-08-26 to 2014-01-18
  • Target version changed from 2013.33-Block.4.4 to 2014.2-Block.1.1

#5 Updated by Chris Jones over 7 years ago

  • Target version changed from 2014.2-Block.1.1 to 2014.14-Block.2.3
  • Due date changed from 2014-01-18 to 2014-04-12

#6 Updated by Dave Vieglais about 7 years ago

  • Due date changed from 2014-04-12 to 2014-09-24
  • Target version changed from 2014.14-Block.2.3 to Maintenance Backlog

#7 Updated by Dave Vieglais almost 4 years ago

  • Status changed from In Progress to Closed
  • % Done changed from 30 to 100

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)