Internship Projects/Mentors
| Page Properties | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Description
ONAP, the Open Network Automation Platform has transformed the telecommunications industry forever and is a key component of the 5G story. This Don't worry though, this Mentorship does not require knowlege of any knowledge of networking or telecommunications. It is instead about writing tools and programmatically automating the the conversion of content from one format to another.
ONAP documentation takes on 2 forms. Most , the ONAP wiki (Confluence) and the formal documentation set (ReadTheDocs) which is in reStructuredText format. Just about all of the of the docs start out as developer documentation developer notes in the ONAP wiki (Confluence) https://wiki.onap.org/. The wiki content is highly uncontrolled, often unstructured and the content gets obsolete rapidly. The second and more important part is the formal documentation set found at https://docs.onap.org/ . The . The formal doc set on the other hand is curated content that is highly structured. Getting content moved from the The latter is the realm of ONAP's Documentation project, a hard working group of folks that are responsible for defining the guidelines and tooling for documentation handling across all ONAP projects. They also help Every time there is a new release of ONAP there is content in the wiki that needs to be migrated into the formal documentation set, but it is a time consuming and mostly manual process. Because of that fact there is a lot of content that does not make its way into ReadTheDocs, which ultimately creates problems for mobile carriers that are deploying ONAP in their networks. The ability for a "one button" conversion from one documentation format to another is necessary to address this issue.
In this mentorship you will be working with the ONAP Technical Community Architect (TCA) and the Project Technical Leader (PTL) for ONAP's Documentation project to create the tooling and automation needed to help ensure that when we cut a new ONAP release the documentation is in the best possible state. They don't write the documentation per-se, but they make sure that the structure, look and feel and similar things are aligned and as complete as possible
...
on the wiki can easily be migrated to ReadTheDocs.
Additional Information
ONAP Wiki: https://wiki.onap.org/
ONAP ReadTheDocs: https://docs.onap.org
Learning Objectives
Expected Outcome
Process automation for migrating/translating documentation from the ONAP Confluence to ONAP ReadTheDocs is in place and usable by the development community.
May involve forking code from an existing repo to be customized specifically for ONAP utilization.
Relation to LF Networking
ONAP
Education Level
Students are required to be enrolled in an undergraduate program to be eligible.
Skills
Java, Groovy, RST. Knowledge of Confluence, Jira and Jenkins a plus.
Future plans
Once delivered it is expected that it will be relatively static