summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-09-10Local Docs Builds1.1.0Trevor Bramwell4-0/+23
Added local sphinx documentation build following this guide: https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html Change-Id: I8d0c430e6fff46dc1bf869fd54f304b0994aca8a Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-04-26Merge "Update release notes for fraser"xiaodong shang1-24/+174
2018-04-26Update release notes for frasershangxdy1-24/+174
Update release notes for new release JIRA: PARSER-178 Change-Id: I9caf66a24b532c96137d5af88b0d62d2a666b052 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2018-04-26Modify user guide for Fraseshangxdy1-21/+145
Update user guide for nfv-toscaprser JIRA: PARSER-177 Change-Id: I68f65c37c4e0c69627467a4c2e1814183638535e Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2018-03-15Add documents for Relase Fshangxdy1-0/+137
nfv-toscaprser api document JIRA: PARSER-173 Change-Id: I94603ce8f6698f424f5249ab1008c15199c35845 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2017-10-19Update notes for release Eshangxdy3-13/+74
Update userguide and release-notes JIRA:PARSER-163 Change-Id: I3b15aa40afcb86a415997fc7e2471894bf3c9f06 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2017-09-12update verigraphserena.spinoso5-14/+113
JIRA: PARSER-154 code optimizations about graph manipulation and formula generation. Change-Id: Idebef19b128281aa2bc40d1aeab6e208c7ddd93d Signed-off-by: serena.spinoso <serena.spinoso@polito.it>
2017-03-17Add verigraph documentationserena.spinoso2-4/+113
Add user guide and test usage documentation. Add examples of service graphs to use verigraph. Change-Id: I3e454e03fa2de99bad0761e3e4a0eab98f2e0b23 Signed-off-by: serena.spinoso <serena.spinoso@polito.it>
2017-03-15Merge "Design document for yang2tosca patch set-4 Signed-off-by: ↵Zhipeng (Howard) Huang1-1/+56
shiva-charan <shiva-charan.m-s@hpe.com> Change-Id: Id3b8c198d08ea71130828d941dcc16ac5b23a421"
2017-03-14Merge "Modify documents about overview"Zhipeng (Howard) Huang2-1/+17
2017-03-14Design document for yang2tosca patch set-4shiva-charan1-1/+56
Signed-off-by: shiva-charan <shiva-charan.m-s@hpe.com> Change-Id: Id3b8c198d08ea71130828d941dcc16ac5b23a421
2017-03-14Modify documents about overviewshangxdy3-2/+18
Add overview about apigateway and tosca2heat. Change-Id: I2994ebcde39dcacd248bd09d33ab48823c12e9a1 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2017-03-13Design document for policy2tosca patch set-2shiva-charan2-1/+41
Signed-off-by: shiva-charan <shiva-charan.m-s@hpe.com> Change-Id: I9f1d1def0c49dadb03c5bcc1d704465eb60cc80a
2017-03-11Add apigateway docsshangxdy10-19/+102
Add documents for apigateway. JIRA:PARSER-123 Change-Id: Ibe8ebd6e3a3f62d58d8da0da4d9be8ceb673fb7b Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2017-03-10Add verigraph documentationriccardo.sisto4-0/+73
Add design doc and installation instructions (pointing to Readme in code base). User manual will be provided in next release Change-Id: I5118894e80a36c1fc0dc29b6e6c3b59637e1b6d0 Signed-off-by: riccardo.sisto <riccardo.sisto@polito.it>
2017-03-10Fix minor format issues in documentsJulien6-57/+38
Change-Id: I9a7267b116338f72f7256b23b517bd7795eba602 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
2017-03-08Adding LabelsShubhamRathi7-0/+14
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: Idd352145f7b984c30aae1939cbe8cd6eb7e228ed Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-07Danube Release Docs Fixup patch 2zhipengh4-56/+146
This patch provide an initial content for the docs/ release/release-notes.rst file. Further work needed. Remove policy2tosca and yang2tosca doc files in the code folder, move tosca2heat diff files to release folder. Remove all the tosca2heat original upstream rst docs due to CI failures Change-Id: I789102a7974b5ac79445f90e08e3f8252e0f4169 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
2017-03-02Danube Release Docs Fixup patch 1zhipengh14-273/+314
Done in this patch 1. Fixes in overview.rst 2. Moves governance folder under docs 3. Adds arno release use case doc from https://wiki.opnfv.org/display/parser/Parser+Use+Cases to the requirement folder 4. Moves two old tosca2heat documents into developer/design/examples 5. Adds new empty tosca2heat and verigraph design document under developer/design. 6. Remove old contents in yang2tosca and policy2tosca design docs since they are all related to installation/execution, not design. 7. Fixes in installation.instruction.rst and usage,guide.rst To do in the following patches 1. Design doc writeup: Xiaodong(tosca2heat), Shiva(yang2tosca/policy2tosca), Serena(verigraph) 2. Release doc writeup: Xiaodong and Howard (postinstall.rst,scenario.description.rst), Serena(verigraph part of release-notes.rst), release-notes.rst Change-Id: If4f51067dd33acd2332e503ee31d6941b4df4c89 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
2017-02-27Release D doc updatezhipengh35-329/+620
Change-Id: I6b2749e5692cf6af2615ff5aff81ff060a1a25d3 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
2016-09-30Update the tosca2heat documents for release Coloradoshangxdy1-2/+21
Update the tosca2heat documents for release Colorado: 1. add brief description for feature or function; 2. add list of tosca keywords in parser. 3. other improvement. JIRA:PARSER-107 Change-Id: I25b46ec2490885534b54cce4bcf5fa030e882785 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-09-20Parser Release C RC1 docs final clean upzhipengh6-22/+170
Change-Id: Ib74e8cbaaa6397e9f9f1e9eba35d7d2f8e8d5108 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
2016-09-16Installation doc and userguide for policy2tosca and yang2toscashiva-charan4-0/+203
Change-Id: I10e5745b75e4cdeafae28767ad8233decabf3482 Signed-off-by: shiva-charan <shiva-charan.m-s@hpe.com>
2016-09-07index and intro docs update for Rel Czhipengh2-0/+13
Change-Id: Ie00fe27841522a4f324e598e37bffbdadac2ec15 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
2016-09-05policy2tosca doc patch set-3shiva-charan1-0/+87
Change-Id: Icc2ad677a55bfe0f58bbfad6305674e7764422ea Signed-off-by: shiva-charan <shiva-charan.m-s@hpe.com>
2016-08-30Adjusted the docs structure according to directivesSofia Wallin4-5/+13
Created a new subdirectory /installationprocedure. Moved the featureconfig.rst and installerconfig.rst to /installationprocedure Added a feature.configuration.rst that should include needed configuration instructions. Please move relevant content to this file and remove the other two (featureconfig.rst and installerconfig.rst) Index file adjusted to updates Change-Id: I54f30b358b4e0685ff98223b1c83c14745c9259b Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-08-22Remove the cyclic dependencies in vRNC definitionshangxdy1-3/+0
Current the high_availability definition in vRNC about active MM/CM VDUs and passive MM/CM VDUs is cyclic dependencies, and the consequence is deployment of vRNC may fall into a infinite loop. The correct definition is passive VDU depend on the active VDU, but the active VDU doesn't depend on the passive VDU. JIRA:PARSER-95 Change-Id: I3f2fb8c0ce959878b12d7da49e2dc81596b4b528 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-08-20Update the documents in Release Cshangxdy7-60/+191
As a developer; I want anybody who cares of project of parser to know what new features in release C; So i update the distribution documents. JIRA:PRASER-87 Change-Id: I0537ba55fa12daa2975f1b794908bca457cfd9c2 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-07-21Substitution mappings doesn't supports propertiesshangxdy1-2/+0
According to the simple tosca specification, substitution mapping only supports key words of node_type, capabilities and requirements, but in the definition of vRNC, add keywords of properties, so it will be deleted Change-Id: I45ca5f6d44410e5a6b8cdb448f3f148d63cc1376 JIRA: PARSER-67 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-07-01Initial release documentsJulien5-0/+108
Submit initial release documents according to opnfvdocs project requirement in Berlin Summit JIRA: PARSER-60 Change-Id: I6eb650259c4da521aee1918842a6d0bfe06a6a0d Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
2016-06-13Create test case about nfv toscashangxdy2-37/+33
As a developer; I want to known the availability of current nfv tosca definitions about node types, capabilities types and relationship types. So i create some test cases to validate it. JIRA: PARSER-34 Change-Id: Id57e38c066eea1d2090a816f5129aa95de464d32 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-05-19Merge "Update the vRNC definition against the latest nfv tosca definition"julien zhang1-108/+153
2016-05-19Merge "Update the vRNC types(node types/relation types) definiton"julien zhang1-175/+32
2016-04-29Update the vRNC definition against the latest nfv tosca definitionshangxdy1-108/+153
Update the vRNC definition according to the latest vRNC type. include node_templates, groups, policies and outputs. JIRA:PARSER-31 Change-Id: Ie69a8e4480188ffad8247d68e5c15085bbb44848 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-04-29Update the vRNC types(node types/relation types) definitonshangxdy1-175/+32
Update the vRNC type definition according to the nfv tosca definiton. include MM, CM, DM and LB. JIRA:PARSER-35 Change-Id: I3017c93081bc77fc2ac1e4633f4232f130f6b4de Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-04-27Update the nfv tosca definietion against the latest specshangxdy1-573/+573
Base types are modified: 1.tosca.nodes.nfv.VDU: from tosca.nodes.SoftwareComponent to tosca.nodes.Compute 2.tosca.nodes.nfv.CP: from tosca.nodes.Root to tosca.nodes.network.Port 3.tosca.nodes.nfv.VL: from tosca.nodes.Root to tosca.nodes.network.Network 4.tosca.relationships.nfv.VirtualBindsTo: from tosca.relationships.ConnectsTo to tosca.relationships.network.BindsTo 5. tosca.relationships.nfv.VirtualLinksTo: from tosca.relationships.ConnectsTo to tosca.relationships.network.LinksTo 6. tosca.capabilities.nfv.VirtualBindable: i from tosca.capabilities.Root to tosca.capabilities.network.Bindable 7. tosca.capabilities.nfv.VirtualLinkable: from tosca.capabilities.Root to tosca.capabilities.network.Linkable. JIRA:PARSER-30 Change-Id: If6f32cf891a979ae88c345980930451f876ad9e0 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-02-26docs: fix issuesRyota MIBU9-95/+128
Change-Id: Ie0917b70674a7a16c89c8e6bc79aed5e436cabdd Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-25update parser documentMatthewLi18-274/+95
JIRA: PARSER-14 document format has been updated, this patch is to improve the document in parser project to satisfy the requirement of sphinx. Change-Id: I629fa84a1b0333e9b59c24cdf7444733f7b35582 Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
2016-01-26Merge "Yang to TOSCA output template for test case."Zhipeng (Howard) Huang1-0/+151
2016-01-18JIRA:PARSER-1 -docs for yang2tosca patch set-3shiva-charan.m-s2-0/+82
Signed-off-by: shiva-charan.m-s <shiva-charan.m-s@hp.com>
2016-01-12Yang to TOSCA output template for test case.shangxdy1-0/+151
As a test engineer,I want to understand how to verify the output of yang-to-tosca based specific input.so that I can define output template. JIRA:PARSER-16 Change-Id: Id17e86db9667715e43615195570854ae1ead5e8b Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2016-01-07JIRA:PARSER-17 Clean up documentation setupzhipengh15-15/+142
Change-Id: I2863a76a5d5417c184283fdf97282c94359162dc
2015-12-22Define a general nfv Tosca template(new)shangxdy6-16/+645
Define a general nfv Tosca template, which supports ETSI/MANO standard. Recheck for changed documents architecture. JIRA:PARSER-6 Change-Id: I0c6f0571c8a5dffbe0bc281d68f2b9542952bf7d Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2015-12-21Merge "Define a TOSCA template for a vRNC(new)"julien zhang4-3/+690
2015-12-21The documents for simple vRNC TOSCA template definition(new)shangxdy3-0/+37
As a Parser developer, I want to konwn the detailed description of TOSCA definition for to a vRNC, so that I can translate it to heat-template. Recheck for changing file format from md to rst. JIRA:PARSER-13 Change-Id: Id666eb076e1ec3bbd428f9a1b6bad1491e3f0d7a Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2015-12-21New Keywods documentation for parser(new).shangxdy1-0/+113
As a user,I need a manual and want to understand how to use all and the new introduced keywords to define a vRNC, so that I can use it to define myown vRNC. Recheck for changing file format from md to rst. JIRA:PARSER-10 Change-Id: Ie7e16ac6f9eede57462d4c83e8acad51ceecc857 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2015-12-21Define a TOSCA template for a vRNC(new)shangxdy4-3/+690
Define a vRNC(an VNF of Radio Network Controller) by using TOSCA template. Recheck for changed documents architecture. JIRA:PARSER-7 Change-Id: I3164b262b2cf3e82f0afc6e3663331d886741c96 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
2015-12-13how to use docs today in OPNFVMatthewLi2-0/+100
JIRA: PARSER-14 please see the documents under /docs directory Change-Id: I7cae579f40b61baec2b277142689be25ba1ca75f Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
2015-03-24JIRA:PARSER-1 -Basic Setup For Parser Gerrit Repohannibalhuang1-0/+1
Change-Id: Iec2941e6f11416c896fedd5d3c8ec249302c40be Signed-off-by: hannibalhuang <huangzhipeng@huawei.com>