From 3cb6b943a0cef8377f4322577adf39b940411ee5 Mon Sep 17 00:00:00 2001 From: Claudio Rosati <claudio.rosati@esss.se> Date: Tue, 24 Jul 2018 09:23:44 +0200 Subject: [PATCH] Updated README.md --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 13b53bf7..bcfb7883 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # ESS CS-Studio OPIs -This folder contains the validated and approved CS-Studio OPI files to be used at ESS to control the facility. +This folder contains the validated and approved CS-Studio OPI files to be used +at ESS to control the facility. ## Structure @@ -146,9 +147,28 @@ target-station/ └── tune-up-dump ``` +## File and Folder Names + +- File and folder names should be in accordance with the naming conventions. +- Folder names must be all lowercase. +- No white spaces are allowed in file/folder names: use '-' instead. + +## Contributing the Repository + +The repository can be cloned by everyone interested in. Changes can be performed +only through Pull Requests. + +Currently only Claudio Rosati (claudio.rosati@esss.se) and Bejamin Bertrand (for +safety, as Infrastructure Group member, benjamin.bertrand@esss.se) are allowed +to approve the pull requests, and merge them into the repository. + +As soon as someone else will be appointed to be in charge of this repository, +this readme file will be updated accordingly. + ## Deployment The ess-opis repository is cloned and mounted in CS-Studio by the [Ansible role](https://gitlab.esss.lu.se/ics-ansible-galaxy/ics-ans-role-cs-studio) used to deploy CS-Studio. -Every time a push is done on the master branch, it triggers an Ansible job via AWX API to update the git repository on the LCR workstations. -Refer to the `.gitlab-ci.yml` file for the implementation. +Every time a push is done on the master branch, it triggers an Ansible job via +AWX API to update the git repository on the LCR workstations. Refer to the +`.gitlab-ci.yml` file for the implementation. -- GitLab