From 10938c647774de7bd8df112377e550f61c62c4d7 Mon Sep 17 00:00:00 2001 From: Ester Milesi Date: Wed, 13 Nov 2024 10:07:16 +0100 Subject: [PATCH] adding homepage to header and add content --- FAQ.md | 13 +++++++++++++ conf.py | 7 ++++--- index.md | 33 +++++++++++++++++++++++++-------- 3 files changed, 42 insertions(+), 11 deletions(-) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..01ed0c9 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,13 @@ +# FAQ + +```{dropdown} How can I provide a colleague with access to Benchling? +First-time access is granted by HR. Contact [Biosustain HR](https://www.inside.dtu.dk/en/medarbejder/hr-og-arbejdsmiljoe/kontakt-hr) to request access for your collegue. +``` + +```{dropdown} How can I provide a colleague with access to my data? +Make sure they are included in the collaborators of your Benchling project. +- If they are part of your team, [add them in the Benchling Team](https://help.benchling.com/hc/en-us/articles/9684243670029-Add-or-remove-members-of-a-team-Enterprise) of your research group and [add the Team as collaborator in your project](https://help.benchling.com/hc/en-us/articles/9684263074445-Set-project-permissions). +- If they are not part of your team, [add them directly as collaborator](https://help.benchling.com/hc/en-us/articles/9684263074445-Set-project-permissions) in your project. +``` + + diff --git a/conf.py b/conf.py index ffd735d..be1cf56 100644 --- a/conf.py +++ b/conf.py @@ -6,7 +6,7 @@ # -- Project information ----------------------------------------------------- -#project = "Benchling resources" +project = "Benchling resources" copyright = "2024, DTU Biosustain, Informatics Platform, Research Data Management Team" #author = "Ester Milesi" @@ -19,7 +19,8 @@ "myst_nb", # "sphinx_design", # https://sphinx-design.readthedocs.io/en/sbt-theme/ # "sphinx_copybutton", # https://sphinx-copybutton.readthedocs.io/ - "sphinx_new_tab_link" + "sphinx_new_tab_link", + "sphinx_design" #This extension enables the hiding of answers in the FAQ page (allow us to use {dropdown}) ] templates_path = ["_templates"] @@ -90,7 +91,7 @@ "show_theme_credit": False } -html_title = '' +html_title = 'Benchling resources' # THEME options # html_theme_options = { diff --git a/index.md b/index.md index 04b910c..f8347c5 100644 --- a/index.md +++ b/index.md @@ -1,17 +1,27 @@ -# Benchling resources +# Welcome to the Biosustain Benchling Resources Page! -Welcome to **Biosustain Benchling resources** page! - -Here you will find **step-by-step guides** and **short videos** to help you track and manage your experimental data in Benchling. +Here you will find **step-by-step guides** and **short videos** to help you navigate Benchling and successfully track and manage your experimental data during your time at Biosustain. +```{dropdown} Explore how we use Benchling at Biosustain At Biosustain, we primarily use Benchling as the central platform for: -- (1) metadata storage -- (2) Electronic Lab Notebook (ELN) -- (3) in-silico molecular design +- samples metadata tracking +- sharing SOPs and electronic notebook (ELN) pages +- in-silico molecular design -For additonal resources, you can always visit the [official Benchling support page](https://help.benchling.com/hc/en-us)! +We also use the platform to submit requests for: +- in-house samples analysis to the [Analytics Team](https://www.biosustain.dtu.dk/technologies/biofoundry/analytics) and the [DNA Foundry](https://www.biosustain.dtu.dk/technologies/biofoundry/dna-foundry) +- orders for lab goods +``` +```{dropdown} Why centralized platforms matter +The main goal of using a centralized platform is to enhance **data findability** and **foster collaboration**. Your sample metadata, notes and SOPs are stored in a single location and linked to each other using notebook @tags and metadata @entity links. +``` + + + +For additonal resources, you can always visit the [official Benchling support page](https://help.benchling.com/hc/en-us)! + [The LIMS Support team](about.md) ```{toctree} @@ -21,6 +31,13 @@ For additonal resources, you can always visit the [official Benchling support pa about ``` +```{toctree} +:maxdepth: 1 +:hidden: + +FAQ +``` + ```{toctree} :maxdepth: 1 :hidden: