there is a doc project https://github.com/onap/doc
the PTL is Thomas Kulik you can see the committers and the project info in the INFO.yaml https://github.com/onap/doc/blob/master/INFO.yaml there are in charged of docs.onap.org - control that the doc is available for the release but of course they cannot write all the doc... I think they animated several sessions during DDF on how to contribute. There are maybe some video of such sessions. Thomas will knwo more than me on that. Documentation is in almost the repositories. All the pieces are aggregated to produce the readthedoc doc. Each project has usually a docs directory e.g. AAI => https://github.com/onap/aai-aai-common/tree/master/docs SO => https://github.com/onap/so/tree/master/docs OOM => https://github.com/onap/oom/tree/master/docs Integration => https://github.com/onap/integration/tree/master/docs .... changing the documentation consists in submitting a patch e.g. patch for a Network slicing use case doc update in Istanbul: submitted in master https://gerrit.onap.org/r/c/integration/+/125060 then cherry picked in Istanbul https://gerrit.onap.org/r/c/integration/+/125582 doc is managed as code through patches with gerrit review on patch submission then merge , the readthe doc is reproduced ________________________________ De : Bob Heinemann <[email protected]> Envoyé : mardi 25 janvier 2022 14:29:39 À : RICHOMME Morgan INNOV/NET; [email protected]; [email protected] Cc : Charles S Bartlett; Sean Choudhury; Charles M Schmidt; Muddasar S Ahmed Objet : RE: [EXT] RE: Instructor Led ONAP Training Thanks for the pointers Morgan. How does one contribute content back for the documentation? Is there a documentation PTL that we could engage with? From: [email protected] <[email protected]> Sent: Tuesday, January 25, 2022 8:24 AM To: [email protected]; [email protected]; Bob Heinemann <[email protected]> Cc: Charles S Bartlett <[email protected]>; Sean Choudhury <[email protected]>; Charles M Schmidt <[email protected]>; Muddasar S Ahmed <[email protected]> Subject: [EXT] RE: Instructor Led ONAP Training Hi Bob for the main concept I would suggest the old book "ONAP demystified" written in 2018. A link seems always active from the blog post https://www.onap.org/blog/2018/07/25/vcpe-blueprint-in-onap. Note that it is old and some components are no more maintained but I did not see any update. Otherwise the reference documentation is https://docs.onap.org/en/latest/ - installation/configuration: https://docs.onap.org/projects/onap-oom/en/latest/index.html#master-index - use cases (including slicing): https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_usecases.html the documents are community documents and could obviously significantly be improved (any contribution is welcome). The documentation of the use cases is usually incremental as new features are added version after version, it makes them difficult to read (already reported in last doc patches. It would clearly make sense to rewrite partly them but the resources to perform such tasks are most of the time not well dimensioned or not planned. For the admin/monitoring: as far as I know there is no specific docs dedicated to this topic. It will usually depend on the infrastructure and the tools your ops are already using. I assume that most of the companies that put ONAP in production are leveraging different tools to monitor, manage their alerts, concentrate the logs, performs backups. It is not specific to ONAP but more linked to the kubernetes services available on the infrastructure hosting ONAP. My 2c /Morgan ________________________________ De : [email protected]<mailto:[email protected]> <[email protected]<mailto:[email protected]>> de la part de Bob Heinemann <[email protected]<mailto:[email protected]>> Envoyé : lundi 24 janvier 2022 21:23:26 À : [email protected]<mailto:[email protected]>; [email protected]<mailto:[email protected]> Cc : Charles S Bartlett; Sean Choudhury; Charles M Schmidt; Muddasar S Ahmed Objet : [onap-discuss] Instructor Led ONAP Training Hi All: Just a general query to the group. Can anyone recommend instructor led training for ONAP? Some topics of interest are installation, configuration, administration, deployment of services, monitoring event data and the network slicing use case? Regards, Bob _________________________________________________________________________________________________________________________ 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. -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#23756): https://lists.onap.org/g/onap-discuss/message/23756 Mute This Topic: https://lists.onap.org/mt/88671125/21656 Group Owner: [email protected] Unsubscribe: https://lists.onap.org/g/onap-discuss/unsub [[email protected]] -=-=-=-=-=-=-=-=-=-=-=-
