From 34f47e3d2db61247546a27f48659b8b79f50fb72 Mon Sep 17 00:00:00 2001 From: Robert Rosca <robert.rosca@xfel.eu> Date: Thu, 4 Mar 2021 21:50:20 +0100 Subject: [PATCH] Tidy up formatting --- README.rst | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 1ccd79f6a..1baabb54a 100644 --- a/README.rst +++ b/README.rst @@ -243,35 +243,29 @@ You'll get a series of plots in the output directory as well. Appendix ******** -Important information that doesn't really fit in as part of the readme. +Important information that doesn't really fit in as part of the readme. TODO: Place this into the docs? Also, improve docs (out of scope for PR !437) -TODO: Check formatting, work done on mobile, also it's markdown not rst - GitLab Access for xcaltst and xcal ================================== -To make it essier to work with and deploy software -via xcaltst/xcal, we have created an xcal account -for gitlab with the following details: +To make it easier to work with and deploy software via xcaltst/xcal, we have +created an xcal account for gitlab with the following details: - Full Name: ReadOnly Gitlab Calibration External - User ID: 423 - Username: xcalgitlab - Password: ask Robert Rosca -This account is intended to be used as a read only -account which can be given access to certain repos -to make it easier to clone them when using our +This account is intended to be used as a read only account which can be given +access to certain repos to make it easier to clone them when using our functional accounts on Maxwell. -The xcaltst account has an ed25519 keypair under -`~/.ssh/gitlab/`, the public key has been added to -the xcalgitlab's approved SSH keys. +The xcaltst account has an ed25519 keypair under `~/.ssh/gitlab/`, the public +key has been added to the xcalgitlab's approved SSH keys. -Additionally this block has been added to -`~/.ssh/config`: +Additionally this block has been added to `~/.ssh/config`: ``` # Special flags for gitlab over SSH @@ -282,9 +276,12 @@ Host git.xfel.eu IdentityFile ~/.ssh/gitlab/id_ed25519 ``` -Now any repository that `xcalgitlab` has read access to, e.g. if it is added as a reporter, can be cloned on Maxwell without having to enter a password. +Now any repository that `xcalgitlab` has read access to, e.g. if it is added as +a reporter, can be cloned on Maxwell without having to enter a password. -For example, xcalgitlab is a reporter on the pycalibration https://git.xfel.eu/gitlab/detectors/pycalibration repository, so now `xcalgitlab` can do passwordless clones with SSH: +For example, xcalgitlab is a reporter on the pycalibration +https://git.xfel.eu/gitlab/detectors/pycalibration repository, so now +`xcalgitlab` can do passwordless clones with SSH: ``` [xcaltst@max-exfl017 tmp]$ git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git -- GitLab