How to use the documentation

This documentation is organized in a hierarchical structure. The main topics are listed in the left sidebar. Each topic has subcategories, which are listed in the dropdown menu of the main topic.

The subcategories are similar for all the main topics and include information about specifications, related projects, the corresponding repositories, usage instructions and practical tutorials.

Subcategories

Subcategory: Scope & Architectures

The Scope & Architectures subcategory provides information about the scope and high-level architecture of the respective project. It includes links to the relevant specifications and standards as well as high-level architecture diagrams about the technology under implementation. It is a good starting point to understand the relevant technologies and to identify the right specifications to study for a deeper understanding.

Subcategory: Roadmap

The Roadmap subcategory links to the relevant GitHub project boards. Typically, the development process of major features in the 5G-MAG Reference Tools is tracked in the “5G-MAG Reference Tools Roadmaps” boards. Developers may use specific boards to track progress on sub-projects.

Subcategory: Features

The Features subcategory provides the coverage of features from the specifications which are alreadya implemented or under consideration for future contributions. It provides a mapping between the specifications and the reference implementations.

Subcategory: Repositories

The Repositories subcategory provides links to the GitHub repositories that are relevant for a main topic. Each repository that is linked here contains build and install instructions. In addition, the link to the GitHub releases and the project boards of a repository are provided. Many of the main topics show synergy to other main topics. Therefore, the links to other related repositories are also provided in this subcategory. As an example, 5G Media Streaming is linked to topics such as 5G Core Networks and UE Data Collection.

Subcategory: Tutorials

The Tutorials subcategory provides end-to-end setup instructions. These instructions guide you through the setup of a specific technology or feature of a technology. Typically, the tutorials combine multiple repositories and components to create an end-to-end setup. Some tutorials reference tutorials of a related topic. This subcategory also provides detailed instructions on how to use single repositories and components.

Subcategory: Requirements

The Requirements subcategory provides information on hardware support to run the 5G-MAG Reference Tools.

Suggested Workflow

Depending on your interest and your level of knowledge, we suggest to follow this workflow:

Make yourself familiar with the high-level architecture of the technology you are interested in following the Scope subcategory.
Learn about the development status in the Roadmap and Features subcategory. This is also a good starting point to map features from a specification to the corresponding repository and implementation.
Check the Repositories subcategories to access the software of the 5G-MAG Reference Tools.
If you are interested in trying out the tools, check the Tutorials and Requirements subcategories.

Feedback / Questions

Before reaching out the maintainers of the 5G-MAG Reference Tools please make sure that you read the documentation. We are happy to answer any questions you might have, but we expect users to read through the documentation first before raising issues.

You can find us on: