Project

General

Profile

Actions

feature request #786

open

Write Developers Guide for CDM Library

Added by Andreas Müller over 13 years ago. Updated 5 months ago.

Status:
New
Priority:
Priority14
Category:
documentation
Target version:
Start date:
04/19/2022
Due date:
04/22/2022 (about 10 months late)
% Done:

0%

Estimated time:
8:00 h
Severity:
major

Description

Write Developers Guide for CDM Library


Related issues

Related to EDIT - task #9954: Refactor EDIT Platform (Wiki) DocumentationClosedAndreas Müller03/11/202203/31/2022

Actions
Actions #1

Updated by Anahit Babadshanjan over 13 years ago

  • Status changed from New to In Progress
Actions #2

Updated by Anahit Babadshanjan over 13 years ago

  • Priority changed from Priority12 to Priority13
Actions #3

Updated by Katja Luther over 13 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 #4

Updated by Katja Luther over 13 years ago

see also #1146

Actions #5

Updated by Katja Luther over 13 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 #6

Updated by Andreas Müller over 1 year ago

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

Updated by Andreas Kohlbecker over 1 year 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 #8

Updated by Andreas Müller over 1 year 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 #9

Updated by Andreas Kohlbecker 12 months ago

  • Assignee changed from Andreas Kohlbecker to Andreas Müller
  • Private changed from Yes to No
Actions #10

Updated by Andreas Müller 12 months ago

  • Status changed from Feedback to New
Actions #11

Updated by Andreas Müller 11 months ago

  • Due date set to 03/31/2022
  • Category changed from cdmlib to documentation
  • Priority changed from Priority13 to Priority14
  • Target version changed from Update Documentation to Release 5.31
  • Start date set to 03/21/2022
  • Estimated time set to 8:00 h

This should be updated during current milestone.

Actions #12

Updated by Andreas Müller 10 months ago

  • Related to task #9954: Refactor EDIT Platform (Wiki) Documentation added
Actions #13

Updated by Andreas Müller 10 months ago

  • Due date changed from 03/31/2022 to 04/22/2022
  • Target version changed from Release 5.31 to Release 5.32
  • Start date changed from 03/21/2022 to 04/19/2022
Actions #14

Updated by Andreas Müller 6 months ago

  • Target version changed from Release 5.32 to Release 5.33
Actions #15

Updated by Andreas Müller 5 months ago

  • Target version changed from Release 5.33 to Update Documentation
Actions

Also available in: Atom PDF