feature request #786: Write Developers Guide for CDM Library - EDIT - EDIT Project Management

Actions

Copy link

feature request #786

open

Write Developers Guide for CDM Library

Added by Andreas Müller almost 15 years ago. Updated over 1 year ago.

Status:

New

Priority:

Priority14

Assignee:

Andreas Müller

Category:

documentation

Target version:

Update Documentation

Start date:

04/19/2022

Due date:

04/22/2022 (over 2 years late)

% Done:

Estimated time:

8:00 h

Severity:

major

Tags:

documentation

Description

Write Developers Guide for CDM Library

Related issues

Actions

Copy link

Updated by Anahit Babadshanjan almost 15 years ago

Status changed from New to In Progress

Actions

Copy link

Updated by Anahit Babadshanjan almost 15 years ago

Priority changed from Priority12 to Priority13

Actions

Copy link

Updated by Katja Luther over 14 years ago

I've just committed the skeleton Docbook documentation to the repository. Please update the parent pom.xml and ./src/.

To compile the sources you can type

mvn -N docbkx:generate-html

to generate html or

mvn -N docbkx:generate-pdf

with the output ending up in target/site/reference/html target/site/reference/pdf

Please let me know if this works for you.

Cheers,

Ben

p.s. It is surprisingly difficult to get a reasonable looking title page. I would counsel against trying to improve it unless you are some kind of docbook / xsl / fop ninja. Also, please remember to add your name to the element in the header of ReferenceDocumentation.xml

Actions

Copy link

Updated by Katja Luther over 14 years ago

Status changed from In Progress to New
Assignee changed from Anahit Babadshanjan to k.luther -
Target version changed from CDM lib Release 2.0 to CDM lib Release 2.3

Actions

Copy link

Updated by Andreas Müller almost 3 years ago

Tags set to documentation
Description updated (diff)
Target version changed from cdmlib - Old Next Major Release to Update Documentation

Actions

Copy link

Updated by Andreas Kohlbecker almost 3 years ago

Status changed from New to Feedback
Assignee changed from Katja Luther to Andreas Müller

I guess we don't need a ticket for this. Partially it is solved already by the wiki and we are only 2.5 developers working on the library, so there is no real need for a documentation like this.

Shouldn't we close this ticket?

Actions

Copy link

Updated by Andreas Müller almost 3 years ago

Assignee changed from Andreas Müller to Andreas Kohlbecker

I agree that we should generally close the ticket as we do not need an extensive documentation. But maybe before closing we should have a look on the existing documentation if things need to be corrected so they are at least not fully wrong.
Also we should always have a working base documentation in case new developpers join the team. This does not need to be extensive as these developers will always be in close contact to us but it should have basic information on how to set up the IDE and maybe some base principals on how we use cdmlib.
I have not checked if this is already the case and how far the existing development is up-to-date.

Actions

Copy link