Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / a4cf27d8797028cf0c2ffc165bf74b89375bf6f7 / . / docs / guides / onap-developer / developing / index.rst
blob: d78f3f8fdfb137b0e8ca6b7ae1beaf9890cad540 [file] [log] [blame]
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
4
5.. _doc_onap-developer_guide_projects:
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]6
7Developing ONAP
8===============
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]9Additional developer level detail is provided for each project below.
10
11Active and Available Inventory
12------------------------------
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]13
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]14.. toctree::
15 :maxdepth: 2
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]16 :titlesonly:
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]17
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]18 ../../../submodules/aai/aai-common.git/docs/index
19 AAI-esr-gui <../../../submodules/aai/esr-gui.git/docs/index>
20 ../../../submodules/aai/esr-server.git/docs/index
21 ../../../submodules/aai/sparky-be.git/docs/index
22
23
24Application Controller
25----------------------
26
27.. toctree::
28 :maxdepth: 2
29 :titlesonly:
30
31 ../../../submodules/appc/deployment.git/docs/index
32 ../../../submodules/appc.git/docs/index
33
34Closed Loop Automation Platform
35-------------------------------
36
37.. toctree::
38 :maxdepth: 2
39 :titlesonly:
40
41 ../../../submodules/clamp.git/docs/index
42
43Common Controller Software Development Kit
44------------------------------------------
45
46.. toctree::
47 :maxdepth: 2
48 :titlesonly:
49
50 ../../../submodules/ccsdk/distribution.git/docs/index
51 ../../../submodules/ccsdk/dashboard.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]52
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame^]53.. Being consolidated in ccsdk distribution
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]54 ../../../submodules/ccsdk/platform/blueprints.git/docs/index
55 ../../../submodules/ccsdk/platform/nbapi.git/docs/index
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame^]56 ../../../submodules/ccsdk/storage/esaas.git/docs/index
57 ../../../submodules/ccsdk/storage/pgaas.git/docs/index
58 ../../../submodules/ccsdk/utils.git/docs/index
59 ../../../submodules/ccsdk/parent.git/docs/index
60 ../../../submodules/ccsdk/platform/plugins.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]61 ../../../submodules/ccsdk/sli/adaptors.git/docs/index
62 ../../../submodules/ccsdk/sli/core.git/docs/index
63 ../../../submodules/ccsdk/sli/northbound.git/docs/index
64 ../../../submodules/ccsdk/sli/plugins.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]65
66Data Collection, Analysis, and Events
67-------------------------------------
68
69.. toctree::
70 :maxdepth: 2
71 :titlesonly:
72
73 ../../../submodules/dcaegen2.git/docs/index
74
75Data Management as a Platform Message Router
76--------------------------------------------
77
78.. toctree::
79 :maxdepth: 2
80 :titlesonly:
81
82 ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
83
84Documentation
85-------------
86
87.. toctree::
88 :maxdepth: 2
89 :titlesonly:
90
91 ../how-to-use-docs/index.rst
92
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]93
94Holmes
95------
96
97.. toctree::
98 :maxdepth: 2
99 :titlesonly:
100
101 Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
102 Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
103
104Integration
105-----------
106
107.. toctree::
108 :maxdepth: 2
109 :titlesonly:
110
111 ../../../submodules/integration.git/docs/index
112
113Logging Enhancements Project
114----------------------------
115
116.. toctree::
117 :maxdepth: 2
118 :titlesonly:
119
120 ../../../submodules/logging-analytics.git/docs/index
121
122Micro Services Bus
123------------------
124
125.. toctree::
126 :maxdepth: 2
127 :titlesonly:
128
129 ../../../submodules/msb/apigateway.git/docs/index
130 ../../../submodules/msb/swagger-sdk.git/docs/index
131
132.. Empty folders in this release
133 ../../../submodules/msb/discovery.git/docs/index
134 ../../../submodules/msb/java-sdk.git/docs/index
135
136
137Modeling
138--------
139
140.. toctree::
141 :maxdepth: 2
142 :titlesonly:
143
144 ../../../submodules/modeling/modelspec.git/docs/index
145 ../../../submodules/modeling/toscaparsers.git/docs/index
146
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame^]147MultiVIM Cloud
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]148--------------
149
150.. toctree::
151 :maxdepth: 2
152 :titlesonly:
153
154 ../../../submodules/multicloud/framework.git/docs/index
155
156
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]157ONAP Command Line Interface
158---------------------------
159
160.. toctree::
161 :maxdepth: 2
162 :titlesonly:
163
164 ../../../submodules/cli.git/docs/index
165
166
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]167ONAP Use Case User Interface
168----------------------------
169
170.. toctree::
171 :maxdepth: 2
172 :titlesonly:
173
174 ../../../submodules/usecase-ui.git/docs/index
175
176Policy Framework
177----------------
178
179.. toctree::
180 :maxdepth: 2
181 :titlesonly:
182
183 ../../../submodules/policy/engine.git/docs/index
184
185Portal Platform
186---------------
187
188.. toctree::
189 :maxdepth: 2
190 :titlesonly:
191
192 ../../../submodules/portal.git/docs/index
193
194Service Design & Creation
195-------------------------
196
197.. toctree::
198 :maxdepth: 2
199 :titlesonly:
200
201 ../../../submodules/sdc.git/docs/index
202
203.. Empty folders for this release
204 ../../../submodules/sdc/jtosca.git/docs/index
205 ../../../submodules/sdc/sdc-distribution-client.git/docs/index
206 ../../../submodules/sdc/sdc-docker-base.git/docs/index
207 ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
208 ../../../submodules/sdc/sdc-tosca.git/docs/index
209 ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
210
211Service Orchestration
212---------------------
213
214.. toctree::
215 :maxdepth: 2
216 :titlesonly:
217
218 ../../../submodules/so.git/docs/index
219 ../../../submodules/so/libs.git/docs/index
220
221Software Defined Network Controller
222-----------------------------------
223
224.. toctree::
225 :maxdepth: 2
226 :titlesonly:
227
228 ../../../submodules/sdnc/oam.git/docs/index
229
230.. Empty folders for this release
231 ../../../submodules/sdnc/adaptors.git/docs/index
232 ../../../submodules/sdnc/architecture.git/docs/index
233 ../../../submodules/sdnc/core.git/docs/index
234 ../../../submodules/sdnc/features.git/docs/index
235 ../../../submodules/sdnc/northbound.git/docs/index
236 ../../../submodules/sdnc/parent.git/docs/index
237 ../../../submodules/sdnc/plugins.git/docs/index
238
239Virtual Function Controller
240---------------------------
241
242.. toctree::
243 :maxdepth: 2
244 :titlesonly:
245
246 ../../../submodules/vfc/nfvo/lcm.git/docs/index
247
248Virtual Infrastructure Deployment
249---------------------------------
250
251.. toctree::
252 :maxdepth: 2
253 :titlesonly:
254
255
256 ../../../submodules/vid.git/docs/index
257
258.. Empty folders for this release
259 ../../../submodules/vid/asdcclient.git/docs/index
260
261VNF Requirements
262----------------
263
264.. toctree::
265 :maxdepth: 2
266 :titlesonly:
267
268
269 ../../../submodules/vnfrqts/guidelines.git/docs/index
270 ../../../submodules/vnfrqts/requirements.git/docs/index
271
272VNF Software Development Kit
273----------------------------
274
275.. toctree::
276 :maxdepth: 2
277 :titlesonly:
278
279 ../../../submodules/vnfsdk/model.git/docs/index