Thanks Arthur But how this parser/component is used within ONAP ?
Best Regards Eric De : Arthur Berezin [mailto:[email protected]] Envoyé : mardi 7 novembre 2017 18:16 À : denghui (L) Cc : DEBEAU Eric IMT/OLN; JORA, SERBAN; Rittwik Jana; [email protected]; [email protected]; [email protected]; BENNETT, RICH; [email protected]; onap-discuss Objet : Re: Modeling Project doc missing On Tue, Nov 7, 2017 at 1:39 PM denghui (L) <[email protected]<mailto:[email protected]>> wrote: Hi Eric, Trimed and inline please, == > Hi Serban, there is one question from Eric for you below Hi Arthur, there is one question from Eric for you inside I think we should provide more example how to use it bot using CLI and API. We should also provide some documentation to explain the TOSCA models that can be managed by the tool (like for the NFV parser: http://onap.readthedocs.io/en/latest/submodules/modeling/toscaparsers.git/docs/nfvparser/userguide/feature.userguide.html) I can check if there is some example in the code. == >As you may know, release 1 is not very stable release, there will be many changes in release 2, especially for modeling part, TSC chair only ask for minimal documentation requirement for each project, I can’t ask more requirement to developers at this moment, some of them are not just busy with this project. For API, It is based on wiki documentation, but it is confusing. We have 3 Parsers describes while only 2 are defined in the Documentation with different names Wiki: • Openstack Tosca Parser API: (Python) • Apache ARIA-TOSCA(Python + CLI + REST API) • Java based Tosca Parser API: (Java) DOC : javatoscachecker<http://onap.readthedocs.io/en/latest/submodules/modeling/toscaparsers.git/docs/javatoscachecker/index.html> NFV Parser<http://onap.readthedocs.io/en/latest/submodules/modeling/toscaparsers.git/docs/nfvparser/index.html> I assume that Java based Tosca Parser API = javatoscachecker<http://onap.readthedocs.io/en/latest/submodules/modeling/toscaparsers.git/docs/javatoscachecker/index.html> And NFV Parser<http://onap.readthedocs.io/en/latest/submodules/modeling/toscaparsers.git/docs/nfvparser/index.html> = Openstack Tosca Parser API: (Python) Which name do we keep: Java based Tosca Parser and NFV Parser ? == > Serban, do you have any suggestion? Where is documented Apache ARIA-TOSCA(Python + CLI + REST API) ? == > I heard that Aria would like their code in SO project, so I don’t know where is their document, Arthur, do you have answer here? The complete project reference documentation can be found on the proejct's home page here: http://ariatosca.incubator.apache.org/docs/html/index.html I suggest starting with the getting started guild here: http://ariatosca.incubator.apache.org/getting-started/ Additionally, you can find more some concrete examples of TOSCA Modeling (Incluidng basic HelloWorld, and more complex ClearWater example) here: https://github.com/apache/incubator-ariatosca/tree/master/examples Best, Arthur We introduced a API ref page within the documentation. I would like to update it with a link to the API rst page from modeling. I propose the following changes. • Merge wiki documentation with RST files if my assumptions are ok • Add an API page for the modeling that will give the links towards the various Parsers API • I update the global API ref for the documentation with the new API page for modeling == > we are asked to publish API in the architecture team, not in modeling, but I am fine with this contribution, we could create another folder on it. Thanks DENG Hui I can do it today if your are ok. Best Regards Eric De : denghui (L) [mailto:[email protected]] Envoyé : mardi 7 novembre 2017 04:11 À : DEBEAU Eric IMT/OLN Cc : BENNETT, RICH Objet : RE: Modeling Project doc missing Hello Eric Thanks a lot for your kind offer. Here is the updated link : http://onap.readthedocs.io/en/latest/submodules/modeling/toscaparsers.git/docs/javatoscachecker/index.html Feel free to let us know if we need to make any further any update. For API, it has been documented on the wiki page https://wiki.onap.org/display/DW/Modeling+API thanks a lot DENG Hui From: [email protected]<mailto:[email protected]> [mailto:[email protected]] Sent: Tuesday, November 7, 2017 1:21 AM To: denghui (L) <[email protected]<mailto:[email protected]>> Cc: BENNETT, RICH <[email protected]<mailto:[email protected]>> Subject: RE: Modeling Project doc missing Hello Hui The documentation for javatoscachecker is still missing We also need to identify if the parsers offer some API. It still unclear for me if the parsers are only some libraries or independent components offering API. If you have some issues to translate the initial PDF file provided for javatoscachecker, we may find a solution. Best Regards Eric De : denghui (L) [mailto:[email protected]] Envoyé : dimanche 29 octobre 2017 07:51 À : Gildas Lanilis; JORA, SERBAN (SERBAN); [email protected]<mailto:[email protected]> Cc : Rittwik Jana; Lingli Deng; [email protected]<mailto:[email protected]>; CHAWKI Jamil IMT/OLN; DEBEAU Eric IMT/OLN; GLOVER, GREG L; Christopher Donley (Chris); BENNETT, RICH Objet : RE: Modeling Project doc missing Hi Serban and Xiaodong. I have created doc folder under the toscaparsers, you could submit/commit your RST document into your folder separately: 1) toscaparsers/docs/javatoscachecker 2) toscaparsers/docs/nfvparser thanks a lot for your kind help, deadline for your submission will be Monday Gildas, I am not sure the deadline will be Monday Pacific time or PTL meeting time? Best regards, DENG Hui From: Gildas Lanilis Sent: Saturday, October 28, 2017 7:24 AM To: JORA, SERBAN (SERBAN) <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]> Cc: Rittwik Jana <[email protected]<mailto:[email protected]>>; Lingli Deng <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; 'CHAWKI Jamil IMT/OLN' <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; GLOVER, GREG L <[email protected]<mailto:[email protected]>>; denghui (L) <[email protected]<mailto:[email protected]>>; Christopher Donley (Chris) <[email protected]<mailto:[email protected]>>; BENNETT, RICH <[email protected]<mailto:[email protected]>> Subject: RE: Modeling Project doc missing Hi Serban, Xiaodong, To help you out, here is a bit of background on where we stand and what is left in term of Documentation in ReadTheDocs<http://onap.readthedocs.io/> Each team representing a project has to have a section in ReadTheDocs to document their project. The expectation for each project usually covers the following (further documented here<http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/include-documentation.html#templates-and-examples>) topics: • Architecture • Offered APIs • Consumed APIs • Delivery • Logging • Installation • Configuration • Administration • Human Interfaces • Release Notes If we step back, we know Modeling has two hats: 1) Modeling Sub committee 2) Modeling project The documentation related to the Modeling sub-committee is already in ReadTheDocs at http://onap.readthedocs.io/en/latest/submodules/modeling/modelspec.git/docs/index.html What is missing is the documentation related to the Modeling project (NFV parser and Javatoscachecker) on the above bullets point. The git structure for Modeling sub-committee repo is already in place at /modeling/modelspec/docs. Consult with Greg and Rich if you need further info or have doubts on how to move forward with ReadTheDocs. Further guidelines are also available in the wiki in https://wiki.onap.org/download/attachments/15995371/Documentation%20Guidelines%209-11-2017.pptm?api=v2 All, I have tried to be as much as informative as possible to help Modeling move forward. Feel free to add-suggest any information that would help in getting a doc that everyone would love to read. Let me know if you have any questions, I will be glad to help. Thanks, Gildas ONAP Release Manager 1 415 238 6287<tel:(415)%20238-6287> From: denghui (L) Sent: Thursday, October 26, 2017 8:29 AM To: JORA, SERBAN (SERBAN) <[email protected]<mailto:[email protected]>>; 'CHAWKI Jamil IMT/OLN' <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; GLOVER, GREG L <[email protected]<mailto:[email protected]>> Cc: Gildas Lanilis <[email protected]<mailto:[email protected]>>; Rittwik Jana <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; Lingli Deng <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]> Subject: RE: Modeling Project doc missing Hi Serban The doc about your code, http://onap.readthedocs.io/en/latest/guides/onap-developer/how-to-use-docs/include-documentation.html your could refer to :VFC project or SO project http://onap.readthedocs.io/en/latest/guides/onap-developer/developing/index.html http://onap.readthedocs.io/en/latest/submodules/vfc/nfvo/lcm.git/docs/index.html http://onap.readthedocs.io/en/latest/submodules/so.git/docs/index.html we need submit those RST files into modeling project repo. thanks a lot for your help Best regards, DENG Hui From: JORA, SERBAN (SERBAN) [mailto:[email protected]] Sent: Thursday, October 26, 2017 11:13 PM To: denghui (L) <[email protected]<mailto:[email protected]>>; 'CHAWKI Jamil IMT/OLN' <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; GLOVER, GREG L <[email protected]<mailto:[email protected]>> Cc: Gildas Lanilis <[email protected]<mailto:[email protected]>>; Rittwik Jana <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; Lingli Deng <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]> Subject: RE: Modeling Project doc missing Hi Deng, Everybody, I think I missed a step here, what documents are we talking about? Thank you, Serban From: denghui (L) [mailto:[email protected]] Sent: Thursday, October 26, 2017 11:02 AM To: 'CHAWKI Jamil IMT/OLN' <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; GLOVER, GREG L <[email protected]<mailto:[email protected]>> Cc: Gildas Lanilis <[email protected]<mailto:[email protected]>>; Rittwik Jana <[email protected]<mailto:[email protected]>>; JORA, SERBAN (SERBAN) <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]>; Lingli Deng <[email protected]<mailto:[email protected]>>; [email protected]<mailto:[email protected]> Subject: Modeling Project doc missing Hello Jamil, Eric and Greg I heard today about what is missing about the document about the binary code, could you kindly help to remind if others are missing for modeling project? Hi Serban and Xiaodong Could you help to submit those doc before end of Sunday, PTL meeting will go through this at the deadline of Monday. Thanks a lot DENG Hui _________________________________________________________________________________________________________________________ Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration, Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci. This message and its attachments may contain confidential or privileged information that may be protected by law; they should not be distributed, used or copied without authorisation. If you have received this email in error, please notify the sender and delete this message and its attachments. As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified. Thank you. _________________________________________________________________________________________________________________________ Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration, Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci. This message and its attachments may contain confidential or privileged information that may be protected by law; they should not be distributed, used or copied without authorisation. If you have received this email in error, please notify the sender and delete this message and its attachments. As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified. Thank you. _________________________________________________________________________________________________________________________ Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration, Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci. This message and its attachments may contain confidential or privileged information that may be protected by law; they should not be distributed, used or copied without authorisation. If you have received this email in error, please notify the sender and delete this message and its attachments. As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified. Thank you.
_______________________________________________ onap-discuss mailing list [email protected] https://lists.onap.org/mailman/listinfo/onap-discuss
