Editing the opsi Documentation

This section explains how to edit the opsi documentation.

Of course, you can also use Git on the command line or 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 the Asciidoctor Documentation.

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

    Click _Edit this Page_ in the browser.

  2. After logging in to GitHub, the online editor opens.

    • (1) Make your changes here.

    • (2) Add a meaningful commit message.

    • (3) GitHub automatically assigns a name for a new branch. Leave the checkbox Create a new branch for this commit and start a pull request enabled so that a pull request is automatically created to merge the development branch into the main branch.

    • (4) Click Propose changes to save your changes and create the pull request.

After reviewing the changes, a uib team member will merge them into the stable branch of the documentation.