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, you need to fork the repository. Then the online editor opens.

    • (1) Make your changes here.

    • (2) Add a meaningful commit message.

    • (3) When your changes are complete, create a pull request.

    • (4) Enter a meaningful title and, optionally, a description, then create the pull request.

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