manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc

   1 [[bk-user-guide]]
   2 = OpenDaylight Developer Guide
   3 :docinfo:
   4
   5 ///////
   6 [dedication]
   7 Example Dedication
   8 ------------------
   9 Optional dedication.
  10
  11 This document is an AsciiDoc book skeleton containing briefly
  12 annotated example elements plus a couple of example index entries and
  13 footnotes.
  14
  15 Books are normally used to generate DocBook markup and the titles of
  16 the preface, appendix, bibliography, glossary and index sections are
  17 significant ('specialsections').
  18
  19
  20 [preface]
  21 Example Preface
  22 ---------------
  23 Optional preface.
  24
  25 Preface Sub-section
  26 ~~~~~~~~~~~~~~~~~~~
  27 Preface sub-section body.
  28 ///////
  29
  30 //////////////////////////
  31 Please note and leave the blank line between include statements here.
  32
  33 It is a defensive measure to prevent individual projects' .adoc files
  34 from eating the next section if they forget to leave a blank line at
  35 the end of their file.
  36 //////////////////////////
  37
  38 A significant amount of this guide has been migrated to: http://docs.opendaylight.org/en/stable-boron/developer-guide/index.html
  39
  40 Please look there as well as here for any content.
  41
  42 = Project-Specific Development Guides
  43
  44 include::alto/alto-developer-guide.adoc[ALTO]
  45
  46 include::atrium/odl-atrium-all-dev.adoc[Atrium]
  47
  48 include::bgpcep/odl-bgpcep-bgp-all-dev.adoc[BGP]
  49
  50 include::bgpcep/odl-bgpcep-bmp-dev.adoc[BGP]
  51
  52 include::capwap/capwap-dev.adoc[CAPWAP]
  53
  54 include::cardinal/odl-cardinal-dev.adoc[]
  55
  56 include::controller/controller.adoc[Controller]
  57
  58 include::didm/didm-dev.adoc[]
  59
  60 include::dlux/dlux-core-dev.adoc[]
  61
  62 include::iotdm/iotdm-dev.adoc[]
  63
  64 include::l2switch/l2switch-dev.adoc[]
  65
  66 include::lacp/lacp-dev.adoc[]
  67
  68 include::controller/netconf/odl-netconf-dev.adoc[]
  69
  70 include::nic/nic-dev.adoc[]
  71
  72 include::nemo/odl-nemo-engine-dev.adoc[]
  73
  74 include::netide/netide-developer-guide.adoc[]
  75
  76 include::neutron/odl-neutron-service-dev.adoc[]
  77
  78 include::neutron/neutron.adoc[]
  79
  80 include::odlparent/odlparent-developer.adoc[]
  81
  82 include::ocpplugin/ocp-developer-guide.adoc[OCP]
  83
  84 include::sdninterfaceapp/odl-sdninterfaceapp-all-dev.adoc[]
  85
  86 include::of-config/of-config-dev.adoc[]
  87
  88 include::openflowjava/odl-openflowjava-protocol-dev.adoc[]
  89
  90 include::openflowplugin/odl-ofp-developer-guide.adoc[]
  91
  92 include::opflex/agent-ovs-dev.adoc[]
  93
  94 include::opflex/genie-dev.adoc[]
  95
  96 include::opflex/libopflex-dev.adoc[]
  97
  98 include::ovsdb/ovsdb-developer.adoc[]
  99
 100 include::bgpcep/odl-bgpcep-pcep-all-dev.adoc[PCEP]
 101
 102 include::packetcable/packetcable-dev.adoc[Packet Cable PCMM Southbound Plugin]
 103
 104 // commenting this out as it contains no content
 105 //include::reservation/reservation-dev.adoc[]
 106
 107 include::faas/odl-faas-dev.adoc[]
 108
 109 include::sfc/sfc.adoc[]
 110
 111 include::snbi/odl-snbi-dev.adoc[]
 112
 113 include::snmp4sdn/snmp4sdn-developer.adoc[SNMP4SDN]
 114
 115 include::sxp/odl-sxp-dev.adoc[]
 116
 117 include::topoprocessing/odl-topoprocessing-framework-dev.adoc[]
 118
 119 include::ttp/ttp-model-dev.adoc[]
 120
 121 include::ttp/ttp-cli-tools-dev.adoc[]
 122
 123 include::unimgr/odl-unimgr-channel-dev.adoc[]
 124
 125 include::usc/odl-usc-channel-dev.adoc[]
 126
 127 include::vtn/vtn-dev.adoc[]
 128
 129 include::yangtools/yangtools.adoc[]
 130
 131 include::yang-push/odl-yang-push-dev.adoc[YANG-PUSH]
 132
 133 :numbered!:
 134
 135 ///////
 136 [appendix]
 137 Example Appendix
 138 ----------------
 139 One or more optional appendixes go here at section level 1.
 140
 141 Appendix Sub-section
 142 ~~~~~~~~~~~~~~~~~~~
 143 Sub-section body.
 144
 145
 146 [glossary]
 147 Example Glossary
 148 ----------------
 149 Glossaries are optional. Glossaries entries are an example of a style
 150 of AsciiDoc labeled lists.
 151
 152 [glossary]
 153 A glossary term::
 154   The corresponding (indented) definition.
 155
 156 A second glossary term::
 157   The corresponding (indented) definition.
 158
 159
 160 [colophon]
 161 Example Colophon
 162 ----------------
 163 Text at the end of a book describing facts about its production.
 164
 165
 166 [index]
 167 Example Index
 168 -------------
 169 ///////
 170
 171 ////////////////////////////////////////////////////////////////
 172 The index is normally left completely empty, it's contents being
 173 generated automatically by the DocBook toolchain.
 174 ////////////////////////////////////////////////////////////////