Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 2da0571d790add6aded355f1ccb68e8daaf081ba / . / docs / guides / onap-developer / developing / index.rst
blob: 7ce12034b65decdc47397b34dc26d2b3e696bf55 [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
52 ../../../submodules/ccsdk/platform/plugins.git/docs/index
53
54.. Empty Folders for Release
55 ../../../submodules/ccsdk/parent.git/docs/index
56 ../../../submodules/ccsdk/platform/blueprints.git/docs/index
57 ../../../submodules/ccsdk/platform/nbapi.git/docs/index
58 ../../../submodules/ccsdk/sli/adaptors.git/docs/index
59 ../../../submodules/ccsdk/sli/core.git/docs/index
60 ../../../submodules/ccsdk/sli/northbound.git/docs/index
61 ../../../submodules/ccsdk/sli/plugins.git/docs/index
62 ../../../submodules/ccsdk/storage/esaas.git/docs/index
63 ../../../submodules/ccsdk/storage/pgaas.git/docs/index
64 ../../../submodules/ccsdk/utils.git/docs/index
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
93External API Framework
94----------------------
95
96.. toctree::
97 :maxdepth: 2
98 :titlesonly:
99
100
101Holmes
102------
103
104.. toctree::
105 :maxdepth: 2
106 :titlesonly:
107
108 Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
109 Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
110
111Integration
112-----------
113
114.. toctree::
115 :maxdepth: 2
116 :titlesonly:
117
118 ../../../submodules/integration.git/docs/index
119
120Logging Enhancements Project
121----------------------------
122
123.. toctree::
124 :maxdepth: 2
125 :titlesonly:
126
127 ../../../submodules/logging-analytics.git/docs/index
128
129Micro Services Bus
130------------------
131
132.. toctree::
133 :maxdepth: 2
134 :titlesonly:
135
136 ../../../submodules/msb/apigateway.git/docs/index
137 ../../../submodules/msb/swagger-sdk.git/docs/index
138
139.. Empty folders in this release
140 ../../../submodules/msb/discovery.git/docs/index
141 ../../../submodules/msb/java-sdk.git/docs/index
142
143
144Modeling
145--------
146
147.. toctree::
148 :maxdepth: 2
149 :titlesonly:
150
151 ../../../submodules/modeling/modelspec.git/docs/index
152 ../../../submodules/modeling/toscaparsers.git/docs/index
153
154ONAP Command Line Interface
155---------------------------
156
157.. toctree::
158 :maxdepth: 2
159 :titlesonly:
160
161 ../../../submodules/cli.git/docs/index
162
163
164ONAP Optimization Framework
165---------------------------
166
167.. toctree::
168 :maxdepth: 2
169 :titlesonly:
170
171 ../../../submodules/optf/has.git/docs/index
172
173ONAP University
174---------------
175
176.. toctree::
177 :maxdepth: 2
178 :titlesonly:
179
180
181ONAP Use Case User Interface
182----------------------------
183
184.. toctree::
185 :maxdepth: 2
186 :titlesonly:
187
188 ../../../submodules/usecase-ui.git/docs/index
189
190Policy Framework
191----------------
192
193.. toctree::
194 :maxdepth: 2
195 :titlesonly:
196
197 ../../../submodules/policy/engine.git/docs/index
198
199Portal Platform
200---------------
201
202.. toctree::
203 :maxdepth: 2
204 :titlesonly:
205
206 ../../../submodules/portal.git/docs/index
207
208Service Design & Creation
209-------------------------
210
211.. toctree::
212 :maxdepth: 2
213 :titlesonly:
214
215 ../../../submodules/sdc.git/docs/index
216
217.. Empty folders for this release
218 ../../../submodules/sdc/jtosca.git/docs/index
219 ../../../submodules/sdc/sdc-distribution-client.git/docs/index
220 ../../../submodules/sdc/sdc-docker-base.git/docs/index
221 ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
222 ../../../submodules/sdc/sdc-tosca.git/docs/index
223 ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
224
225Service Orchestration
226---------------------
227
228.. toctree::
229 :maxdepth: 2
230 :titlesonly:
231
232 ../../../submodules/so.git/docs/index
233 ../../../submodules/so/libs.git/docs/index
234
235Software Defined Network Controller
236-----------------------------------
237
238.. toctree::
239 :maxdepth: 2
240 :titlesonly:
241
242 ../../../submodules/sdnc/oam.git/docs/index
243
244.. Empty folders for this release
245 ../../../submodules/sdnc/adaptors.git/docs/index
246 ../../../submodules/sdnc/architecture.git/docs/index
247 ../../../submodules/sdnc/core.git/docs/index
248 ../../../submodules/sdnc/features.git/docs/index
249 ../../../submodules/sdnc/northbound.git/docs/index
250 ../../../submodules/sdnc/parent.git/docs/index
251 ../../../submodules/sdnc/plugins.git/docs/index
252
253Virtual Function Controller
254---------------------------
255
256.. toctree::
257 :maxdepth: 2
258 :titlesonly:
259
260 ../../../submodules/vfc/nfvo/lcm.git/docs/index
261
262Virtual Infrastructure Deployment
263---------------------------------
264
265.. toctree::
266 :maxdepth: 2
267 :titlesonly:
268
269
270 ../../../submodules/vid.git/docs/index
271
272.. Empty folders for this release
273 ../../../submodules/vid/asdcclient.git/docs/index
274
275VNF Requirements
276----------------
277
278.. toctree::
279 :maxdepth: 2
280 :titlesonly:
281
282
283 ../../../submodules/vnfrqts/guidelines.git/docs/index
284 ../../../submodules/vnfrqts/requirements.git/docs/index
285
286VNF Software Development Kit
287----------------------------
288
289.. toctree::
290 :maxdepth: 2
291 :titlesonly:
292
293 ../../../submodules/vnfsdk/model.git/docs/index
294
295VNF Validation
296--------------
297
298.. toctree::
299 :maxdepth: 2
300 :titlesonly:
301