Migrate general installation instructions to reST

[docs.git] / manuals / getting-started-guide / src / main / asciidoc / ch-introduction.adoc

diff --git a/manuals/getting-started-guide/src/main/asciidoc/ch-introduction.adoc b/manuals/getting-started-guide/src/main/asciidoc/ch-introduction.adoc
index 4250320223fe91cb0fd386cc833740ae92e8693d..26d81f0df688bfe65ba3f56bb05a20ec3f9c62da 100755 (executable)
--- a/manuals/getting-started-guide/src/main/asciidoc/ch-introduction.adoc
+++ b/manuals/getting-started-guide/src/main/asciidoc/ch-introduction.adoc
@@ -1,28 +1,31 @@
-== OpenDaylight Controller Overview
-The OpenDaylight project is a collaborative open source project that aims to accelerate adoption of Software-Defined Networking (SDN) 
-and Network Functions Virtualization (NFV) with a transparent approach that fosters new innovation and reduces risk. 
-
-OpenDaylight mainly consists of software designed to be run on top of a Java Virtual Machine (JVM) and can be run on any operating system
-and hardware as long as it supports Java. OpenDaylight is an implementation of the
-Software Defined Network (SDN) concept and makes use of the following third-party tools:
-
-* *Maven*: OpenDaylight uses Maven for easier build automation. Maven uses pom.xml
-(Project Object Model) to script the dependencies between bundles and also to describe
-which bundles to load and start.
-
-* *OSGi*: OSGi framework is the back-end of OpenDaylight as it allows dynamically
-loading bundles and packages JAR files, and binding bundles together for exchanging
-information.
-
-* *JAVA interfaces*: Java interfaces are usually generated by compiling the YANG project. Java interfaces are used for event listening, specifications, and forming
-patterns. This is the main way in which specific bundles implement call-back functions for events and also to indicate awareness of specific state.
-
-* *REST APIs*: Most of the REST APIs in OpenDaylight are defined using YANG tools and are RESTCONF APIs.
-
-* *Karaf*: TBD
-
-Add content related to Lithium (TBD)
-
-For a more detailed overview of the OpenDaylight controller, see the _OpenDaylight
-Developer Guide_
+[preface]
+== OpenDaylight Overview
+The OpenDaylight project is a collaborative open source project that
+aims to accelerate adoption of Software-Defined Networking (SDN) and
+Network Functions Virtualization (NFV) with a transparent approach that
+fosters new innovation.
+
+OpenDaylight mainly consists of software designed to be run on top of a
+Java Virtual Machine (JVM) and can be run on any operating system and
+hardware as there is a Java Runtime Environment (JRE) available for it.
+
+// TODO: uncomment the following lines when we have them to the point we think they're useful.
+// OpenDaylight makes use of the following third-party tools:
+//
+// * *Maven*: OpenDaylight uses Maven for easier build automation. Maven uses pom.xml
+// (Project Object Model) to script the dependencies between bundles.
+//
+// * *OSGi*: OSGi framework is the back-end of OpenDaylight as it allows dynamically
+// loading bundles and packages JAR files, and binding bundles together for exchanging
+// information.
+//
+// * *JAVA interfaces*: Java interfaces are usually generated by compiling the YANG project. Java interfaces are used for event listening, specifications, and forming
+// patterns. This is the main way in which specific bundles implement call-back functions for events and also to indicate awareness of specific state.
+//
+// * *REST APIs*: Most of the REST APIs in OpenDaylight are defined using YANG tools and are RESTCONF APIs.
+//
+// * *Karaf*: TBD
+
+For a more detailed information about OpenDaylight, see the and _OpenDaylight User Guie_, _OpenDaylight
+Developer Guide_.