Skip to content

Commit

Permalink
🚨 Fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
jemrobinson committed Aug 14, 2024
1 parent d5ff32b commit 948687d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 11 deletions.
6 changes: 5 additions & 1 deletion docs/source/roles/researcher/accessing_the_sre.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ If you aren't sure about any of these then please return to the **{ref}`Set up y
:::

- Enter your password at the prompt and click on the **{guilabel}`Next`** button

::::

::::{admonition} 3. Login with MFA
Expand Down Expand Up @@ -146,11 +147,13 @@ You should now be able to see the SRE dashboard screen which will look like the
:::

::::{note}

- The Linux desktops within our workspaces use the [Ubuntu operating system](https://ubuntu.com/).
- The desktop environment used by our workspaces is called [Xfce](https://docs.xfce.org/xfce/).

::::

**Welcome to the Data Safe Haven SRE! {{wave}}**
Welcome to the Data Safe Haven SRE! {{wave}}

## {{unlock}} Access additional workspaces

Expand All @@ -171,6 +174,7 @@ You will access this machine in a similar way to the main shared desktop, by sel
:::

- This will bring her to the normal login screen, where she will use the short-form username **ada.lovelace** and her password as before.

::::

:::{tip}
Expand Down
14 changes: 8 additions & 6 deletions docs/source/roles/researcher/new_user_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ SRE ID
SRE URL
: each SRE has a unique URL (for example **sandbox.projects.example.org**) which is used to access the data.


(roles_researcher_setup_your_account)=

## {{rocket}} Set up your account
Expand Down Expand Up @@ -132,8 +131,10 @@ You might receive the {ref}`SRE URL <roles_researcher_sre_url>` at this time, or

:::{note}
In this document Ada Lovelace - our example user - will be participating in the **sandbox** project.

- Her **{ref}`username domain <roles_researcher_username_domain>`** is **projects.example.org**.
- Her **{ref}`SRE URL <roles_researcher_sre_url>`** is **https://sandbox.projects.example.org**.

:::

(roles_researcher_password_and_mfa)=
Expand Down Expand Up @@ -205,16 +206,15 @@ Please follow these steps carefully.

- Select a password that complies with the [Microsoft Entra requirements](https://learn.microsoft.com/en-us/entra/identity/authentication/concept-sspr-policy#microsoft-entra-password-policies):


:::{tip}
We suggest the following:

- minimum 12 characters
- only alphanumeric characters
- at least one each of:
- {{input_latin_uppercase}} uppercase character
- {{input_latin_lowercase}} lowercase character
- {{input_numbers}} number
- {{input_latin_uppercase}} uppercase character
- {{input_latin_lowercase}} lowercase character
- {{input_numbers}} number
- not used anywhere else
- use a [password generator](https://bitwarden.com/password-generator/) to ensure you meet these requirements
:::
Expand Down Expand Up @@ -306,6 +306,7 @@ This is known as multi-factor authentication (MFA).
:::

- Click **{guilabel}`Done`**

::::

::::{admonition} 4. Check the Security Information dashboard
Expand Down Expand Up @@ -333,8 +334,8 @@ Search for **Microsoft Authenticator** in your phone's app store or follow the a
- {{apple}} iOS: `https://bit.ly/iosauthenticator`
- {{robot}} Android: `https://bit.ly/androidauthenticator`
- {{bento_box}} Windows mobile: `https://bit.ly/windowsauthenticator`
::::

::::

::::{admonition} 2. Open authenticator app
:class: dropdown note
Expand All @@ -356,6 +357,7 @@ Search for **Microsoft Authenticator** in your phone's app store or follow the a
:::

- Open the app

::::

::::{admonition} 3. Register your app
Expand Down
3 changes: 0 additions & 3 deletions docs/source/roles/researcher/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ If you have never used a Linux desktop before, you might find some of the follow
:::
::::


::::{admonition} Miscellaneous
:class: dropdown note

Expand All @@ -114,7 +113,6 @@ If you have never used a Linux desktop before, you might find some of the follow

For a more detailed introduction, visit the official Ubuntu tutorial, [The Linux command line for beginners](https://ubuntu.com/tutorials/command-line-for-beginners)


(roles_researcher_git_basics)=

### {{notebook}} Git basics
Expand Down Expand Up @@ -179,7 +177,6 @@ Pull request
::::{admonition} Working with branches
:class: dropdown note


- To create a new branch

:::{code} bash
Expand Down
9 changes: 8 additions & 1 deletion docs/source/roles/researcher/using_the_sre.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ The workspace has several pre-installed applications and programming languages t
If you need anything that is not already installed, please discuss this with the designated contact for your SRE.

You can access applications from the desktop using either:

- the **Terminal** app accessible from the dock at the bottom of the screen
- via a drop-down menu when you right-click on the desktop or click the **{menuselection}`Applications`** button on the top left of the screen

Expand Down Expand Up @@ -211,6 +212,7 @@ There are several shared folder on each workspace that all collaborators within
- [input data](#input-data): in the **/data/** folder
- [shared space](#shared-space): in the **/shared/** folder
- [output resources](#output-resources): in the **/output/** folder

<!-- - [scratch space](#scratch-space-scratch): `/scratch/` -->
<!-- - [backup space](#backup-space-backup): `/backup/` -->

Expand Down Expand Up @@ -312,6 +314,7 @@ Use your **{ref}`short-form username <roles_researcher_username>`** and **passwo
:::

- Then click the **{guilabel}`Sign in`** button

::::

::::{admonition} Create a new repository
Expand Down Expand Up @@ -378,7 +381,6 @@ Use your **{ref}`short-form username <roles_researcher_username>`** and **passwo

::::


(roles_researcher_gitea_create_pull_request)=

::::{admonition} Create a pull request in Gitea
Expand Down Expand Up @@ -454,6 +456,7 @@ Use your **{ref}`short-form username <roles_researcher_username>`** and **passwo
:::

- Then click the **{guilabel}`Sign in`** button

::::

::::{admonition} Editing other people's documents
Expand Down Expand Up @@ -515,6 +518,7 @@ Official tutorials for [MSSQL](https://learn.microsoft.com/en-us/sql/sql-server/
- **Password**: provided by your {ref}`System Manager <role_system_manager>`
- **Database name**: provided by your {ref}`System Manager <role_system_manager>`
- **Port**: 1433

:::

:::{admonition} PostgreSQL server connection details
Expand All @@ -525,6 +529,7 @@ Official tutorials for [MSSQL](https://learn.microsoft.com/en-us/sql/sql-server/
- **Password**: provided by your {ref}`System Manager <role_system_manager>`
- **Database name**: provided by your {ref}`System Manager <role_system_manager>`
- **Port**: 5432

:::

Examples are given below for connecting using **DBeaver**, **Python** and **R**.
Expand Down Expand Up @@ -581,6 +586,7 @@ Click on the **{guilabel}`New database connection`** button (which looks a bit l
:::

- If drivers are not available contact your {ref}`System Manager <role_system_manager>`

::::

#### PostgreSQL
Expand Down Expand Up @@ -630,6 +636,7 @@ Click on the **{guilabel}`New database connection`** button (which looks a bit l
:::

- If drivers are not available contact your {ref}`System Manager <role_system_manager>`

::::

### {{snake}} Connecting using Python
Expand Down

0 comments on commit 948687d

Please sign in to comment.