docs/templates/component-info/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 XXXX Component Information
   5 ==========================
   6 High level architecture, design, and packaging information for release planning and delivery.
   7
   8 .. toctree::
   9    :maxdepth: 1
  10
  11
  12 Delivery
  13 --------
  14 Th package component is composed of the functional layers and packaged into run-time components as illustrated in the following diagrams.
  15
  16 .. blockdiag::
  17
  18
  19    blockdiag layers {
  20    orientation = portrait
  21    a -> m;
  22    b -> n;
  23    c -> x;
  24    m -> y;
  25    m -> z;
  26    group l1 {
  27         color = blue;
  28         x; y; z;
  29         }
  30    group l2 {
  31         color = yellow;
  32         m; n;
  33         }
  34    group l3 {
  35         color = orange;
  36         a; b; c;
  37         }
  38
  39    }
  40
  41
  42 Offered APIs
  43 ------------
  44
  45 .. csv-table::
  46    :header-rows: 0
  47    :header: "Container or Library", "API Reference", "Purpose", "Protocol", "Port", "TCP/UDP"
  48    :widths: 20, 25, 25, 10, 10, 10
  49    :delim: |
  50    :file: offered-apis.csv
  51
  52
  53 Consumed APIs
  54 -------------
  55
  56 .. csv-table::
  57    :header-rows: 0
  58    :header: "Project Repo/Group ID", "Container or Library Offering API"
  59    :widths: 30, 30
  60    :delim: |
  61    :file: consumed-apis.csv
  62
  63 Logging & Diagnostic Information
  64 --------------------------------
  65 Description of how to interact with and diagnose problems with the components in the run-time packaging.