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).

• [x] [done] Overview page
• [ ] Web API
  • [x] Port WebServiceAPI page from old wiki
  • [ ] Clientlibs
  • [ ] clientlib-java
    • [x] Javadoc (@josteinaj)
    • [ ] Example usage (@josteinaj)
  • [ ] clientlib-go
    • [x] 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
  • [x] Overview page
  • [ ] Javadoc (@bertfrees)
    • [ ] framework-core
    • [ ] common-utils
    • [ ] xproc-api
    • [ ] modules-registry
    • [ ] xmlcatalog
  • [ ] API docs for other modules
  • [ ] Overview page per module
    • [x] braille modules
  • [x] Java
  • [x] XProc
  • [ ] XSLT
• [ ] Updater
• [ ] Installer
• [ ] [doing] Developer Guide (result)
  • [x] License
  • [x] Build system, build tools (in progress) (@bertfrees)
  • [x] Build documentation (in progress) (@bertfrees)
  • [x] Version Management
  • [x] Commit rules
  • [x] Releasing (@bertfrees)
  • [x] 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 https://github.com/daisy/pipeline-tasks/issues/32)
  • [ ] ...
• [ ] Documentation for each component
  • [ ] API docs (see above)
  • [ ] Required Java version
• [x] [done] Easy hacks link
  • [ ] Add "easyhack" labels
  • see also https://github.com/daisy/pipeline-tasks/issues/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.