Roadmap to Specification

[openBackhaul]

Collaboration

• Read Introduction to Git and GitHub
• Read Workflow for Contributing
• Read GitFlow Workflow
• Create own GitHub account #9
• Install Git #10
• Install Visual Studio Code #11
• Connect Visual Studio Code with GitHub #12
• Make yourself familiar with the Basic Syntax of Markdown
• Read Formulating Issues
• Read Formulating Commit and Merge Request Messages
• Read Management of Conflicts
• Read Avoiding Conflicts
• Contribute to Content of Introduction #13

High Level Design

ServiceList

• Read Structure of Services
• Read Structure of ServiceNames
• Read Structure of Release Numbers
• Read Structure of UUIDs in general and for details about Servers and Clients
• Read Concept of ServiceList
• Create ServiceList #14

ProfileList

• Read Concept of Profiles
• Structure of UUIDs in general and for details about Profiles
• Read Concepts of ProfileList and ProfileInstanceList
• Create ProfileList #15
• Create ProfileInstanceList #16

ForwardingList

• Read Concepts of Internal Forwarding
• Read Structure of Internal Forwardings
• Read Types of Internal Forwardings
• Read Substructure of Management of Internal Forwarding
• Read Structure of Internal Forwarding Names
• Read Concepts of the ForwardingList
• Read Structure of the ForwardingList
• Read Structure of a Description of a Forwarding
• Create ForwardingList #26

Concrete Specification

CONFIGfile

• Read Concept of the CONFIGfile
• Read Concept of the DATAfile
• Read Structure of the CONFIGfile
• Read ONF Core Model Overview
• Read ControlConstruct
• Read ProfileCollection and Profile
• Read LogicalTerminationPoint and LayerProtocol
• Read ForwardingDomain, ForwardingConstruct and ForwardingConstructPort
• Create CONFIGfile #27

OAS

• Read Concept of Microservice
• ('Microservices' at Wikipedia site could also be read for a bit more complete picture)
• Read Introduction to HTTP Requests
• Read about the API-First Approach
• Read about the OpenAPI Specification definitions
• Read the OpenAPI Guide from Basic Structure to Using $ref
• (In case of any doubts during applying OpenAPI Specification, looking into its definition might help, but it is not recommended to read the entire document.)
• Open an existing OAS (e.g. RegistryOffice) and study it line by line while reading Structure of the OAS
• Create OAS #28