Migrating project-specific install guides from adoc to reST
[docs.git] / manuals / getting-started-guide / src / main / asciidoc / bk-getting-started-guide.adoc
1 [[bk-getting-started-guide]]
2 = OpenDaylight Getting Started Guide
3 :docinfo:
4
5 //////////////////////////
6 // BEGIN COMMENT
7 [dedication]
8 Example Dedication
9 ------------------
10 Optional dedication.
11
12 This document is an AsciiDoc book skeleton containing briefly
13 annotated example elements plus a couple of example index entries and
14 footnotes.
15
16 Books are normally used to generate DocBook markup and the titles of
17 the preface, appendix, bibliography, glossary and index sections are
18 significant ('specialsections').
19
20
21 [preface]
22 Example Preface
23 ---------------
24 Optional preface.
25
26 Preface Sub-section
27 ~~~~~~~~~~~~~~~~~~~
28 Preface sub-section body.
29
30 Using OpenDaylight
31 --------------------------
32
33 [partintro]
34 .Optional part introduction title
35 --
36 Optional part introduction goes here.
37 --
38
39 OpenDaylight Add-ons
40 -------------------------
41
42 [partintro]
43 .Optional part introduction title
44 --
45 Optional part introduction goes here.
46 --
47 // END COMMENT
48 //////////////////////////
49
50 //////////////////////////
51 // BEGIN COMMENT
52 Please note and leave the blank line between include statements here.
53
54 It is a defensive measure to prevent individual projects' .adoc files
55 from eating the next section if they forget to leave a blank line at
56 the end of their file.
57 // END COMMENT
58 //////////////////////////
59
60 include::general_installation.adoc[]
61
62 = Getting to know OpenDaylight
63
64 include::ch-introduction.adoc[]
65
66 include::ch-dlux.adoc[]
67
68 include::ch-xsql-commands.adoc[]
69
70 include::ch-clustering.adoc[]
71
72 include::ch-controller-version.adoc[]
73
74 include::chapter_security_considerations.adoc[]
75
76 :numbered!:
77
78 //////////////////////////
79 // BEGIN COMMENT
80 [appendix]
81 Example Appendix
82 ----------------
83 One or more optional appendixes go here at section level 1.
84
85 Appendix Sub-section
86 ~~~~~~~~~~~~~~~~~~~
87 Sub-section body.
88
89
90 [glossary]
91 Example Glossary
92 ----------------
93 Glossaries are optional. Glossaries entries are an example of a style
94 of AsciiDoc labeled lists.
95
96 [glossary]
97 A glossary term::
98   The corresponding (indented) definition.
99
100 A second glossary term::
101   The corresponding (indented) definition.
102
103
104 [colophon]
105 Example Colophon
106 ----------------
107 Text at the end of a book describing facts about its production.
108
109
110 [index]
111 Example Index
112 -------------
113 // END COMMENT
114 //////////////////////////
115
116 ////////////////////////////////////////////////////////////////
117 The index is normally left completely empty, it's contents being
118 generated automatically by the DocBook toolchain.
119 ////////////////////////////////////////////////////////////////