This is the documentation of an pre-release opsi version. The documentation for the current version 4.3 can be found here.

Editing the opsi Documentation

This section explains how to edit the opsi documentation directly in our GitLab instance.

Of course, you can also use Git on the command line or work with a graphical client, download the files of our documentation in AsciiDoc format and work in the text editor of your choice. If you are not yet familiar with AsciiDoc, we recommend taking a look at Asciidoctor Documentation.

  1. Open the opsi manual in the browser and click on the pencil icon in the upper right corner to edit the current page.

    Click _Edit this Page_ in your web browser

  2. The login dialog of our GitLab instance opens. Log in with your credentials. If you don’t have an account yet, please read How to Contribute to opsi.

    Log into our opsi GitLab instance

  3. After logging in, the GitLab editor opens.

    The GitLab editor

    • (1) Make your changes on this page.

    • (2) Add a meaningful commit message.

    • (3) GitLab automatically assigns a name for a new branch. Leave the Start a new merge request with these changes checkbox selected to automatically create a request to merge the development branch into the main branch.

    • (4) Click Commit changes to save your changes and create the merge request.

After reviewing the changes, a uib staff member is going to transfer your changes to the stable branch of the documentation.