Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed _static/images/project-creation-3.gif
Binary file not shown.
Binary file added _static/images/project-creation-updated2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _static/images/settings_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs/Dataset/Add_Dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,4 +206,10 @@ To remove a Lineage:
```
----------------------------

<br/>
## API Availability

The actions described in this page can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:

* [**/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/datasets/create_dataset_datasets_post)
* [**/projects-datasets**](https://datacatalog.bright.dtu.dk/api/docs#/projects-datasets)
* [**/lineage**](https://datacatalog.bright.dtu.dk/api/docs#/lineage)
7 changes: 7 additions & 0 deletions docs/Dataset/Manage_Datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,11 @@ The tab displays a table view with:
After the initial save, you can grant or remove additional permissions for a user, by selecting or deselecting the options available. Changes apply immediately.

```
-------------------------------

## API Availability

The actions described above can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:

* [**/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/datasets)
* [**/policies/datasets**](https://datacatalog.bright.dtu.dk/api/docs#/policies)
22 changes: 20 additions & 2 deletions docs/Project/Create_Project.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ Complete all the required fields marked with **`*`**:
* Project Description (**`*`**)
* Access Rights (**`*`**)
* Principal Investigator (PI) (**`*`**)
* LIMS (Benchling) project URL _(must start with **https://bright.benchling.com**)_


```{tip}

To find the Benchling project URL, log in to Benchling, open the **Projects** section in the left sidebar, and select the project you want.
Click the **settings** button (<img src="../../_static/images/settings_button.png" alt="open_icon" style="height:1.2em; vertical-align:text-bottom;">) next to the project name and choose **Copy project link**.

```


## Final Step: Complete Project Creation
Expand All @@ -43,7 +52,7 @@ Click **`Create project`** at the ***bottom*** of the page to complete the proce

<br/>

```{figure} ../../_static/images/project-creation-3.gif
```{figure} ../../_static/images/project-creation-updated2.gif
:alt: Project Creation
:width: 93%
:align: center
Expand Down Expand Up @@ -131,4 +140,13 @@ If either of these is missing, you will not be able to proceed.

```{note}
This relationship also appears under the **Projects** tab on the **dataset home page**.
```
```

--------------------------------

## API Availability

The actions described in this page can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:

* [**/projects**](https://datacatalog.bright.dtu.dk/api/docs#/projects/create_project_projects_post)
* [**/projects-datasets**](https://datacatalog.bright.dtu.dk/api/docs#/projects-datasets)
5 changes: 5 additions & 0 deletions docs/Project/DMP.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,11 @@ This section includes questions about compliance and data sharing:
→ **BRIGHT-visible**: READ-ONLY access for project and dataset metadata is granted to all BRIGHT employees. Access to files in Microsoft Azure Storage account remains restricted to project members and collaborators.
```

----------------------------

## API Availability

Some of the fields used when creating a DMP can also be set programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:

* [**/dmp**](https://datacatalog.bright.dtu.dk/api/docs#/dmp)

7 changes: 7 additions & 0 deletions docs/Project/Manage_Projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ The tab displays a table view with:
To grant or remove permissions for a user, simply click or unclick the options available. Changes apply immediately.
```

----------------------------

## API Availability

The actions described above can also be performed programmatically using our **FastAPI**. For more details, see the following endpoints in our API Reference:

* [**/projects**](https://datacatalog.bright.dtu.dk/api/docs#/projects)
* [**/policies/projects**](https://datacatalog.bright.dtu.dk/api/docs#/policies)


6 changes: 5 additions & 1 deletion docs/Search.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,8 @@ To make your search more precise, try combining **multiple filters** at once.
```
----------------------------

<br/>
## API Availability

The search can also be performed programmatically using our **FastAPI**. For more details, see the following endpoint in our API Reference:

* [**/search**](https://datacatalog.bright.dtu.dk/api/docs#/search/search_search_post)
Loading