scs/system-config
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
system-config/doc/source/docsportal.rst
Artem Goncharov ab29626444 Initial data
2023-03-29 13:35:19 +02:00

1.7 KiB
Raw Blame History

title

Documentation Portal

Documentation Portal

Documentation portal is a web server that serves documentation maintained by various git projects.

At a Glance

Hosts
Projects
Configuration
Bugs
Resources

Overview

Every project managed by the Zuul Eco tenant is capable to use general jobs for publishing documentation and releasenotes. Those jobs push rendered html content into the Swift (dedicated containers) and make them word readable.

Integration of projects under the Zuul allows following:

  • CI for the changes in the project (i.e. only tested and approved content is being merged into the main branch)
  • CD: for the changes that are being merged documents are being built and pushed to the HelpCenter.

Software Architecture

A Web-Server (nginx) is listening in the frontend for the requests and based on the URL decides in which container the data is actually located. It contacts Storage server and gets the original content from there, which is then being cached and returned back to the requestor.

dot/docsportal.dot

Deployment

:git_file:`playbooks/service-docs.yaml` is a playbook for the service configuration and deployment. It is automatically executed once a pull request touching any of the affected files (roles, inventory) is being merged. Additionally it is applied periodically.