forked from Controls/gitea-pages
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# Overview
|
|
|
|
Description of the documentation structure.
|
|
|
|
## Who are we?
|
|
|
|
The tab *"1. Home"* is about the Controls section, announcements for events, and
|
|
useful stuff as a kind of "quick link".
|
|
|
|
## What do we do?
|
|
|
|
This question is ansered in the tab *"2. Services Portfolio"* with a list of
|
|
all services supported by the Controls section. In addition you can find here
|
|
lists of supported hardware and epics drivers.
|
|
|
|
## Help to suceed
|
|
|
|
The *"3. Knowledge Center"* is a collection of How-To pages, workflow
|
|
descrioptions and explanations of the architecture used inside the PSI
|
|
control systems. In *"4. Contacts Support"* you find lists with
|
|
Controls Contacts for various expert groups, beamlines, and topics as well as
|
|
the service owners of Controls services. The *"5. Controls Internal"* tab
|
|
contains internal procedures like onboarding, how to do travel requests and
|
|
the Control system team charter.
|
|
|
|
## How to change or contribute content
|
|
|
|
This webpage is hosted in Gitea:
|
|
[](https://gitea.psi.ch/Controls/gitea-pages/actions)
|
|
|
|
It uses the site generator [Zensical](https://zensical.org/docs/setup/basics/)
|
|
together with Gitea Actions to convert
|
|
[Markdown](https://www.markdownguide.org/cheat-sheet/) text files
|
|
into html webpages. To contribute, check out the gitea repository, update
|
|
the content and check in again
|
|
([a simple git help](https://rogerdudler.github.io/git-guide/index.html)).
|
|
A predefined workflow will publish the changes automatically after some
|
|
seconds - just reload the webpage in your browser.
|