Skip to content

Commit 76d9845

Browse files
committed
Updates for researcher-facing OS docs
1 parent b6a65da commit 76d9845

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

docs/getting-started/how-to/create-a-code-repository-for-your-project/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ To create a repository for your OpenSAFELY project, you can either:
1313
- Have a new repository created for you in the `opensafely` GitHub organisation
1414
- Create a repository in your own GitHub account, and request to have this trasnferred to the `opensafely` GitHub organisation later
1515

16-
You can find more information about both of these options, and how to create a repository, in the [Creating a repository for a project](docs/repositories.md/#Creating-a-repository-for-a-project) section of the OpenSAFELY documentation.
16+
You can find more information about both of these options in the [Creating a repository for a project](docs/repositories.md/#Creating-a-repository-for-a-project) section of the OpenSAFELY documentation.

docs/jobs-site.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ The [jobs site](https://jobs.opensafely.org/) is where you can run your code on
44

55
The jobs site is centred around **Projects**. When an application to run a study in OpenSAFELY is [approved by the data controller](https://www.opensafely.org/onboarding-new-users/), a _Project_ is automatically created. You can see a [list of approved projects, and the organisation they belong to](https://www.opensafely.org/approved-projects/).
66

7-
We will add any GitHub usernames listed in your approval to our `opensafely` [GitHub organisation](https://github.com/opensafely). We will also ask you to [transfer](https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository) your existing OpenSAFELY study repository (if you have one) into the same organisation. This allows OpenSAFELY to enforce certain security standards, such as [multi-factor authentication](https://docs.github.com/en/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa).
7+
We will add any GitHub usernames listed in your approval to our `opensafely` [GitHub organisation](https://github.com/opensafely). We will also ask you to [transfer](https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository#transferring-a-repository-owned-by-your-personal-account) your existing OpenSAFELY study repository (if you have one) into the same organisation. This allows OpenSAFELY to enforce certain security standards, such as [multi-factor authentication](https://docs.github.com/en/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa).
88

99
!!! warning
10-
It is important that the study repository is _transferred_ into the `opensafely` organization, not _forked_ into it. Please [ask us](how-to-get-help.md#slack) if you have any problems with this process.
10+
It is important that the study repository is _transferred_ into the opensafely organization, not forked into it. Please request to transfer your existing OpenSAFELY study repository by following the process outlined [here](repositories.md/#how-to-transfer-an-existing-repository-to-the-opensafely-organization).
11+
1112

1213
Within each _Project_, there are one or more **Workspaces**, which are linked to a GitHub repository in the [OpenSAFELY organisation](https://github.com/opensafely). Any [actions](actions-intro.md) you develop as part of your [project pipeline](actions-pipelines.md) within the attached repository are linked to the workspace, allowing these to be run against real data.
1314

docs/project-completion.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Ensure your repo is as tidy as possible once you have completed your project. Co
2727

2828

2929
### License
30-
Check your repo has a `LICENSE` file. We recommend the [MIT licence](https://opensource.org/license/mit), as it is an [open source license with strong community support](https://opensource.org/licenses?categories=popular-strong-community) and allows modification and distribution without cost. An MIT License has been included as part of the research template repository; you will need to edit the first line to include the current year and the name of your organisation.
30+
Check your repo has a `LICENSE` file. We recommend the [MIT licence](https://opensource.org/license/mit), as it is an [open source license with strong community support](https://opensource.org/licenses?categories=popular-strong-community) and allows modification and distribution without cost. An MIT License has been included as part of the research template repository; you will need to edit the first line to include the current year and the name of your organisation.
3131

3232

3333
### Tests
@@ -69,7 +69,7 @@ You will be prompted to check various bits of metadata associated with the repos
6969
Once you have completed this page it will be checked by the OpenSAFELY team before being made public.
7070

7171
!!! info
72-
You will be prompted to make it public sooner, if you first ran the code against an OpenSAFELY database more than 12 months ago.
72+
Private repositories within the opensafely GitHub organisation are made public after 12 months. This means that your repository may be made public before project completion, if you first ran the code against an OpenSAFELY database more than 12 months ago. You can find more information about repository visibility and how this is managed [here](repositories.md/#repository-visibility).
7373

7474
## Make your outputs on the jobs site public
7575

docs/repositories.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ You may want to start work on a project before approval by creating a repository
7474

7575
### How to transfer an existing repository to the opensafely organization
7676

77-
To request that a repository be transferred from your own GitHub account to the OpenSAFELY GitHub organisation, please contact [Tech Support](how-to-get-help.md/#slack).
77+
To transfer a repository from your personal GitHub account to the OpenSAFELY organisation, follow the instructions [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository#transferring-a-repository-owned-by-your-personal-account). You will then need to contact [Tech Support](how-to-get-help.md/#slack), to request approval for the repository transfer.
7878

79-
If your request is approved, Tech Support will make the transfer and you will be notified once this has been completed.
79+
If your request is approved, Tech Support will notify you once the transfer has been completed. You will also be able to see the repository on the OpenSAFELY organisation [Repositories page](https://github.com/orgs/opensafely/repositories).
8080

8181
The settings of any transferred repositories will be updated to match the default opensafely repository settings, listed below:
8282

docs/workflow.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ The following assumes that a well-defined and ethically-approved research agenda
55

66
The workflow for a single study can typically be broken down into the following steps:
77

8-
1. **Create a git repository** from the [template repository provided](https://github.com/opensafely/research-template) and clone it on your local machine.
9-
This repo will contain all the code relating to your project, and a history of its development over time.
8+
1. **Clone your OpenSAFELY research repository** from GitHub onto your local machine. This repo will contain all the code relating to your project, and a history of its development over time.
109
2. **Write a [dataset definition](ehrql/index.md)** that specifies what data you want to extract from the database:
1110
- specify the patient population (dataset rows) and variables (dataset columns)
1211
- specify the expected distributions of these variables for use in dummy data

0 commit comments

Comments
 (0)