Ticket #110 (accepted todo)

Opened 3 years ago

Last modified 11 months ago

Builddrone documentation via pipadoc

Reported by: ct Owned by: ct
Priority: normal Milestone:
Component: infrastructure Keywords: builddrone asciidoc bash
Cc: Blocked By:
Blocking:

Description

Builddrone is very undocumented yet (but the code is very simple)
nevertheless some basic design decisions shall be documented. That are the BUILDDRONE_* variables to pass data around, the CamelCase naming for soup functions and how results and errors are passed around.

This should be done in pipadoc/asciidoc.

things to do in detail:

  • commit pipadoc (are the new plugins needed?) to builddrone
  • make a basic setup (doc/ dir?)
  • maybe write a makefile or some shell script to generate the docs

Change History

comment:1 Changed 2 years ago by ct

  • Keywords builddrone added

comment:2 Changed 2 years ago by ct

  • Keywords asciidoc added

comment:3 Changed 2 years ago by ct

  • Keywords bash added

comment:4 Changed 11 months ago by ct

  • Owner set to ct
  • Status changed from new to accepted

builddrone v2 will be sufficiently different and really needs to be documented now, i am started working on this

Note: See TracTickets for help on using tickets.