docs/release-notes/index.rst

   1 #############
   2 Release Notes
   3 #############
   4
   5 Execution
   6 ---------
   7
   8 OpenDaylight includes `Karaf <https://karaf.apache.org>`_ containers, `OSGi <https://www.osgi.org>`_
   9 (Open Service Gateway Initiative) bundles, and Java class files, which are portable and can run on
  10 any Java 11-compliant JVM (Java virtual machine). Any add-on project or feature of a
  11 specific project may have additional requirements.
  12
  13 Development
  14 -----------
  15
  16 OpenDaylight is written in Java and utilizes Maven as a build tool. Therefore,
  17 the only requirements needed to develop projects within OpenDaylight include:
  18
  19 * `Java JDK 11 <https://www.oracle.com/java/technologies/javase/products-doc-jdk11certconfig.html>`_
  20 * `Apache Maven <https://maven.apache.org>`_ 3.5.2 or later
  21
  22 If an application or tool is built on top of OpenDaylight’s REST APIs, it does not
  23 have any special requirement beyond what is necessary to run the application or tool
  24 to make REST calls.
  25
  26 In some instances, OpenDaylight uses the `Xtend <https://www.eclipse.org/xtend/>`_ lamguage.
  27 Even though Maven downloads all appropriate tools to build applications; additional plugins
  28 may be required to support IDE.
  29
  30 Projects with additional requirements for execution typically have similar or
  31 additional requirements for development. See the platforms release notes for details.
  32
  33 Platform Release Notes
  34 ======================
  35
  36 .. toctree::
  37    :glob:
  38    :maxdepth: 1
  39
  40    upgrade-process
  41
  42 Project Release Notes
  43 =====================
  44
  45 .. toctree::
  46    :glob:
  47    :maxdepth: 1
  48
  49 ..   projects/*
  50
  51 Service Release Notes
  52 =====================
  53
  54 .. toctree::
  55    :glob:
  56    :maxdepth: 1
  57
  58 ..   release-notes-*
  59
  60 .. toctree::
  61    :maxdepth: 1
  62    :hidden:
  63
  64    sample-release-notes