Skip to main content
Software Accelerator

Using this Documentation

This documentation is organised by project. Each project (for example 5G Media Streaming, 5G Multicast Broadcast Services or 5G Broadcast) has pages in several sections of the site, and they all share the same project menu on the left, so you can move between them without going back to the top navigation.

Sections of a project​

Technical Analysis​

The Technology section explains how a technology works. Each project has a Technical Analysis with an Overview, an Architecture, its Features and its Procedures, and, for some projects, analyses of open questions.

Specifications​

The Specifications pages list the standards behind a project (3GPP, MPEG, ETSI and others), the release in which each one appeared, and the standards work 5G-MAG tracks. Each project has a Specification list. A Release history gives the work items and the changes release by release where it exists.

Reference Tools, Testbeds and Validation Tools​

Under Developer, the Reference Tools, Testbeds and Validation Tools pages describe the software. A project opens on its Repositories page with a short description, the standards it implements, its contributors, and its repositories with their latest releases and open pull requests, and, where there is one, a link to its roadmap on GitHub. Where a project has them, the Repositories page is followed by:

  • Implementation status: what the code implements, component by component, where the project has been audited against the specifications. Some projects have no such page yet.
  • Tutorials: step-by-step guides to set up and run the software. Many walk through several components working together; some focus on one.

A missing page or an empty list means that nothing has been published yet for that project, not that a page is broken.

Deployments​

The Deployments pages cover testing, interoperability events such as PlugFests, and, per project, what is available to deploy.

Developer Exchange​

Where a project has recorded talks or demonstrations, they appear on its Repositories page, and the full collection is on the Developer Exchanges page.

Suggested workflow​

First, decide how you want to enter the documentation. To understand a technology, start from Technology. To read the specifications behind it, start from Specifications. To run a tool, start from Reference Tools; for step-by-step guides, start from Tutorials.

Then, for a project:

  1. Understand the design: read the Technical Analysis overview and the Specification list.
  2. Assess the status: open Implementation status, where it exists, to see what is implemented, and use the project's roadmap on GitHub to see what is planned. Major features are also tracked on the Reference Tools Roadmaps board.
  3. Get the code: use the Repositories page of the project to clone or download the software. The same release data appears on the Community Activity page.
  4. Set it up: follow the Tutorials, and the Developer Exchange recordings where they exist.

Feedback and support​

Please consult this documentation before contacting the maintainers. If your questions remain unanswered, see Get in Touch on the Developer Community page for how to reach us.