Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.24 KB

README.md

File metadata and controls

63 lines (42 loc) · 2.24 KB
Raw

Open Build Service Documentation

This is the official, edited and reviewed documentation for the Open Build Service (OBS).

The documentation is currently split into these books:

  • The OBS Beginner's Guide
  • The OBS User Guide
  • The OBS Administration Guide
  • The OBS Reference Guide
  • The OBS Best Practices Guide

For more ideas and TODOs, see the Trello board at https://trello.com/b/DxiucSKw/obs-documentation

Building the books

To build those documents you need to install openSUSEs DocBook Authoring and Publishing Suite (daps).

After editing the document validate your changes via the following commands, for example:

$ daps -d DC-obs-beginners-guide validate

Similar for other guides. HTML documentation can get generated via

$ daps -d DC-obs-beginners-guide html

Development Environment

We are also shipping a docker/docker-compose based development environment you can use.

  1. Since we mount the repository into our container, we need to map your local user id to the one of the container user:

    sed "s/REPLACE_THIS_WITH_YOUR_ID/`id -u`/" docker-compose.override.yml.example > docker-compose.override.yml

  2. Then you can build the development environment with:

    docker-compose build

  3. And after it's built, you can run any command in it via:

    docker-compose run --rm obs-docu daps -vv -d DC-obs-all html

Update Documentation

The first steps to update the documentation are:

  • Fork obs-docu project and clone the fork on your computer.
  • Prepare the development environment following the instructions above.
  • Add or correct a piece of documentation.
  • Commit your changes in a new branch and send a Pull Request (as in any other repository).
  • Wait until your changes are merged.

Once the Pull Request is approved and merged, your changes are ready to be deployed. However, the OBS documentation is hosted online at openbuildservice.org, so you should move to obs-landing repository where you'll find the instructions to deploy.