diff --git a/docs/adding-a-paper.md b/docs/adding-a-paper.md new file mode 100644 index 000000000..86fe1ac33 --- /dev/null +++ b/docs/adding-a-paper.md @@ -0,0 +1,40 @@ +# Adding an OpenSAFELY paper to OpenSAFELY.org + +We are very keen to compile all pre-printed and published OpenSAFELY studies on [opensafely.org](https://www.opensafely.org). + +To do this, open a new file in a text editor of your choice. Populate the file using the following template: + +``` +--- +title: "Short title for the page" +date: yyyy-mm-dd +status: "preprint" or "published" +paper: "Title of the paper" +description: "Description of the paper" +cite: "How to cite this paper" +link: "https://doi.org/..." +project: Approved project number (see https://www.opensafely.org/approved-projects/) +repo: "OpenSAFELY GitHub repository name" +--- + +## Abstract + +### Background + +### Methods + +### Results + +### Conclusions + +``` + +First, update the frontmatter (i.e., the text between the `---`s) with the correct details for your paper. Note that `status:` should have the value `preprint` or `published` to indicate the current status of your manuscript. Then, add the necessary text below the `## Abstract` line to include the abstract. + +This file format is called "Markdown", for more help writing Markdown documents, see: + +- [Markdown Guide: Basic Syntax](https://www.markdownguide.org/basic-syntax/) +- [Markdown Guide: Cheat Sheet](https://www.markdownguide.org/cheat-sheet/) +- [Dillinger: this shows a preview of your Markdown as you type](https://dillinger.io/) + +This file can then be incorporated into our website by anyone with the required access; if you are an external researcher, then you can send this to your co-pilot who will have the necessary permissions. diff --git a/docs/project-completion.md b/docs/project-completion.md index 7806d839c..50790d25d 100644 --- a/docs/project-completion.md +++ b/docs/project-completion.md @@ -74,3 +74,7 @@ Once you have completed this page it will be checked by the OpenSAFELY team befo ## Make your outputs on the jobs site public Once you have approval from NHSE to publish your work, consider making all outputs released to the project workspace on the jobs site "published". See the [publication instructions](jobs-site.md#publishing-outputs). + +## Add your publication to the OpenSAFELY website + +Refer to our guidance on [adding a publication to the OpenSAFELY website](adding-a-paper.md). diff --git a/mkdocs.yml b/mkdocs.yml index b40e88cc4..c39913fee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -77,6 +77,7 @@ nav: - Managing your OpenSAFELY project: - Telling us about changes to your project: project-changes.md - Project completion: project-completion.md + - Adding your pre-print/paper to OpenSAFELY.org: adding-a-paper.md - Information for system integrators: system-integration.md - Legacy: - Study definitions: