Skip to content

Getting Started

This website is an overview of all the automations used by IT Services. The content of this site is dynamically built from various repos in GitLab using CI/CD.

Information about how to start developping code, how the automation platforms work and some tips & tricks, can be found on the IT services sharepoint site

Adding documentation

Adding documentation to this site is done by providing a markdown file (myfile.md) with the same name of the script you are documenting in the repository of the script itself. In most cases the markdown file is placed next to the script, but this can vary depending on the repo.

Templates

Templates for documenting can be found in the doc-templates folder in the git repo of this documentation site. In case a new type of templates is needed, it can also be saved in this folder.

The minimal requirements for every documentation are:

  • Name of the automation.
  • Link (or path) where the automation can be found.
  • Link to the repository of the script.
  • Description of the automation

Tip

Descriptions can easilly be generated with Copilot/chatGPT by typing: "summarize the script below in max 100 words" and then paste your script.

To avoid language mix-up, we decided to use English as the default language for all documentation.

Diagrams

You can use Mermaid to add diagrams and visualizations to you documentation.

There are different types of schematics. For some examples, see the official docs

Tip

Also here Copilot/chatGPT can create mermaid code in seconds by typing: "add a mermaid flowchart to the .md file to clarify the the working of the playbook" and then paste your script.

Dependencies

Automations can be tagged with dependencies. This makes it easy to see which script interact with a certain component. An overview of all dependencies and the script where they are used, can be found in the dependencies menu item.

GitLab only documentation

You can always add a README.md file in your repo if you want to provide some info for people who look in GitLab. README.md files are excluded from the sync to the docsite.