Skip to content

GitLab

The TS-GitLab will have to shut down towards the end of the year — please think about migrating your projects to GitLab.com or GitHub.
(This is still a very early message, meant to keep you informed. There will be more urgent ones in the future.)

Closed
Created by Lukas Riedel@lriedelOwner5 of 5 tasks completed5/5 tasks

Use simple doc server to deploy DORiE docs

Description

Utopia uses a simple Doc server instance for deploying its documentation. The instance runs on our Hermes server. As indicated in #143 (closed), our current hosting situation on Netlify has several shortcomings. Most notably, we cannot deploy multiple versions of the documentation. ReadTheDocs, on the other hand, only allows building the documentation itself, which means that it cannot include files that are configured by CMake. Both are issues we can remedy by using our own server.

Proposal

Upload the Doxygen and the Sphinx documentation to our own doc server.

Preparation steps:

  • Update the doc_server to be able to serve an arbitrary repository: utopia/doc_server#2
  • Include an instance of the doc server into the Hermes server setup: infrastructure/gitlab_setup#22

Repository:

Project:

  • Add/update Project Badges
  • Add private SSH key

Hermes server:

  • Add public SSH key to authorized_keys of doc server container

One interesting addition to the deploy routine in Utopia would be to deploy docs for MRs as well, such that docs can be directly reviewed online before merging.

How to test the implementation?

Pipeline succeeds and deploys documentation to doc server.

Related issues

See #143 (closed)

Edited by Lukas Riedel
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information