Developer documentation

[bertfrees]

Result: http://daisy.github.io/pipeline/Contribute

Note: people can use the web API or could use the Pipeline as a library without "contributing". So maybe the name of the page needs to change (or split it up in two).

• [done] Overview page
• Web API
  • Port WebServiceAPI page from old wiki
  • Clientlibs
    • clientlib-java
      • Javadoc (@josteinaj)
      • Example usage (@josteinaj)
    • clientlib-go
      • link to README
  • Example client programs (python, ruby, php, dotnet, go, ...)
    • see https://github.com/daisy/pipeline-framework/tree/master/webservice/samples/clients
• Pipeline as a Library
  • Generate documentation from code (javadoc, xprocdoc, etc.) (in progress) (@bertfrees)
  • Native Java API
    • Overview page
    • Javadoc (@bertfrees)
      • framework-core
      • common-utils
      • xproc-api
      • modules-registry
      • xmlcatalog
  • API docs for other modules
    • Overview page per module
      • braille modules
    • Java
    • XProc
    • XSLT
• Updater
• Installer
• [doing] Developer Guide (result)
  • License
  • Build system, build tools (in progress) (@bertfrees)
  • Build documentation (in progress) (@bertfrees)
  • Version Management
  • Commit rules
  • Releasing (@bertfrees)
  • Development tools, set up development environment, Eclipse (@bertfrees)
  • Links to specifications/guides for technologies used, notably XProc
  • Page that explains the Pipeline specific extensions to XProc (for script metadata) and XMLCatalog
  • Debugging (@bertfrees)
  • Branching pattern (see Branching pattern #32)
  • ...
• Documentation for each component
  • API docs (see above)
  • Required Java version
• [done] Easy hacks link
  • Add "easyhack" labels
    • see also Github issues cleanup #91

See also:

• updater.doc (Slack) by Javi
• @YLBrailleNet's Eclipse document (Slack)
• https://github.com/snaekobbi/wiki/wiki/What-is-a-Pipeline-module%3F
• https://github.com/snaekobbi/wiki/wiki/Building
• https://github.com/snaekobbi/wiki/wiki/Debugging
• https://github.com/daisy/pipeline/blob/doc/gui/README.md
• https://github.com/daisy/pipeline/blob/doc/modules/braille/README.md
• https://github.com/daisy/pipeline/blob/doc/webui/README.md
• https://github.com/daisy/pipeline/blob/doc/modules/scripts/dtbook-to-zedai/src/main/dev-notes.md
• https://github.com/mtmse/pipeline/blob/master/jenkins.md

[josteinaj]

Web API > Clientlibs > Javadoc for clientlib-java

JavaDoc updated in daisy/pipeline-clientlib-java#18

[bertfrees]

Great. I'll publish it on the website.