Skip to content

Documenting

OpenSlice's documentation runs on MkDocs.

This page is a WIP. Updates are ongoing.

Eligibility

Documenting OpenSlice is limited to active contributors. So, if you:

  1. are an active member or participant;

  2. wish to contribute to it;

  3. you're ready!

Documentation System and Structure

MkDocs is a fast and simple static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.

Getting Started

To contribute to OpenSlice's documentation, you need to follow those easy steps:

  1. Clone the repository with:

    bash git clone https://labs.etsi.org/rep/osl/documentation.git

  2. Checkout the desired branch (don't forget to select one or make one!):

    bash git checkout develop #[or another branch]

  3. Document (and commit)! 😊

The documentation website supports branches, so your changes will be reflected in the corresponding branch.