BIND 10 #3006: Import datasource design documentation into BIND 10 git repo

[BIND 10 Development]

#3006: Import datasource design documentation into BIND 10 git repo
-------------------------------------+-------------------------------------
            Reporter:  muks          |                        Owner:  muks
                Type:  task          |                       Status:
            Priority:  medium        |  reviewing
           Component:                |                    Milestone:
  documentation                      |  Sprint-20130625
            Keywords:                |                   Resolution:
           Sensitive:  0             |                 CVSS Scoring:
         Sub-Project:  DNS           |              Defect Severity:  N/A
Estimated Difficulty:  0             |  Feature Depending on Ticket:
         Total Hours:  0             |          Add Hours to Ticket:  0
                                     |                    Internal?:  0
-------------------------------------+-------------------------------------
Changes (by vorner):

 * owner:  vorner => muks


Comment:

 Hello

 I agree that the class diagram might need some improvements. For one, the
 original one had layers (which seemed very useful) that are lost in this
 one.

 Distcheck fails, with:
 {{{
 make[5]: *** No rule to make target `overview.png', needed by `all'.
 Stop.
 make[5]: Entering directory
 `/tmp/bind10/bind10-2/bind10-20130529/_build/doc/design/datasrc'
 }}}

 I think we don't want to require these tools on normal user's system to
 compile the sources. If one of the tools is not ready, it will reject
 compilation. We don't compile man pages if docbook is not available, I
 think the same approach would be reasonable for developer documentation.
 Especially with the `plantuml`, which is not available as package for
 gentoo (and I see reasons why their ebuild they provide on the wiki page
 was not accepted).

 What is `a2x`? Why is it mentioned in both rules in the makefile?

 Is this generic make syntax, or GNU extension?
 {{{
 BUILT_SOURCES = \
         $(UML_FILES:.txt=.png) \
         $(TEXT_FILES:.txt=.html)
 }}}

 Are the diagram sources written by hand, or some tool helps with them?
 Writing the formatted text is easy, but these seem rather more complex.

 I didn't read the text thoroughly, but I guess it is the same one as from
 Jinmei.

-- 
Ticket URL: <http://bind10.isc.org/ticket/3006#comment:4>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development