Booktype detailed documentation
  • Vote Up0Vote Down Nicolas DufourNicolas Dufour
    Posts: 29Member
    Hi,

    I found a Booki dev book, maintained by Aleksandar Erkalovic, but it's rather short, and doesn't really my needs.
    As a sysadmin, I'd like some documentation on how the different services (redis, celery, rabbitmq...) interact and what's the role of each one.
    As a bug hunter (and translator), I'd like some details on the code structure (e.g. the role of the booki, booktype, booktypecontrol and sputnik libs), so that I can easier find the cause of a bug (or a problem with a string).
    Yes, I know writing docs for code is not fun at all, but I feel there's something missing here. Or maybe I just didn't searched the right place?

    Regards,
    --
    Nicolas
  • 3 Comments sorted by
  • Vote Up0Vote Down Daniel JamesDaniel James
    Posts: 844Member, Sourcefabric Team
    Hi Nicolas,

    There are some developer docs at http://booktype.readthedocs.io/en/latest/ but you might find they lack sufficient detail. I'd welcome suggestions for improvement.

    Cheers!

    Daniel
  • Vote Up0Vote Down Nicolas DufourNicolas Dufour
    Posts: 29Member
    Yes, that's the docsI found, but it doesn't fit my needs unfortunately. Maybe the dev team still has some internal work drawings or draft that could help ;)

    Thanks for your help!
    --
    Nicolas
  • Vote Up0Vote Down Daniel JamesDaniel James
    Posts: 844Member, Sourcefabric Team
    Hi Nicolas,

    There is some older material in https://wiki.sourcefabric.org/display/Booktype/ but it is likely to be out of date. Please let me know if you find anything useful there so I can move it into the maintained docs.

    If you need to know anything specific, please ask in this forum :-)

    Cheers!

    Daniel
Add a Comment