Skip to content

Commit

Permalink
Minor appearance adjustments and page re-structures
Browse files Browse the repository at this point in the history
  • Loading branch information
dinhe878 committed Jan 29, 2025
1 parent f149938 commit 8697b4d
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 18 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ The layout of the website is defined in the `index.md` file.
```bash
sphinx-build -n -W --keep-going -b html ./ ./_build/
```
in case for forcing a full rebuild of the HTML output and ensures that all files, including your custom CSS, are updated, do:
```bash
python -m sphinx -n -a -E -W --keep-going -b html ./ ./_build/
```
in case the command is not found, try:
```bash
python -m sphinx -n -W --keep-going -b html ./ ./_build/
Expand Down
11 changes: 11 additions & 0 deletions _static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
/* Set the background color for the primary color in the header and footer area*/
header.bg-primary {
background-color: #bc3b2f !important;
}
footer.bg-primary {
background-color: #bc3b2f !important;
}

/* Hide the first-level breadcrumb navigation item in the navbar */
.breadcrumb-item:first-child {
display: none; /* Hides the first-level " ol > li" element which is "Docs" */
}

/* Hide the separator for the first breadcrumb item */
.breadcrumb-item:first-child + .breadcrumb-item::before {
content: none; /* Removes the separator (e.g., ">") */
}
5 changes: 0 additions & 5 deletions about.md

This file was deleted.

2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@

html_theme_options = {
"project_name": "DTU Biosustain Data Catalog Resources",
"github_url": "https://github.com/biosustain/data-catalog-resources",
"github_url": "https://github.com/biosustain/data-catalog-resources/blob/main/",
"logo": "images/datacat.svg"
}

Expand Down
File renamed without changes.
18 changes: 6 additions & 12 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,24 @@ Specific goals include:

[**CKAN**](https://ckan.org/) is one of the most popular open source data management system used by governments and organizations such as [Open Data DK](https://www.opendata.dk/) and [US government Open Data](https://data.gov/). CKAN also has a powerful API (Application Programming Interface), which makes it possible and relatively easy to develop extensions and integrate with our informatics platform at Biosustain.

## Dataset and Resources
## Key Features

### Dataset and Resources

In the data catalog powered by CKAN, data is published in units called **"datasets"**. A dataset is a parcel of data - for example, it could be the DNA sequencing reads of an experiment bacterial strain, the growth profile of cells for a fermentation experiment, or statistical analyses of gene expressions. When you search for data, the search results you see will be individual datasets.

A dataset contains two things:
- Information or **“metadata”** about the datasets. For example, common metadata such as the title and creator, date-of-creation, format, etc. Also some dataset type specifics such as **raw data**, **results**, or it is available in, what license it is released under, etc.
- A number of **“resources”**, which hold the data (file) itself. A resource can be a CSV or Excel spreadsheet, XML file, PDF document, image file, sequencing fastq, metabolic model file, an url (linking to files), etc. A dataset can contain any number of resources. For example, different resources might contain the data for different experiments, or they might contain the same data in different formats.

## Members, Projects and Authorization
### Members, Projects and Authorization

Biosustain Data Catalog, by design, is **only accessible** by personnel officially employed or associated with DTU Biosustain. Each dataset is owned by a project. Project administrators can add individual members to it, with different roles depending on the level of authorization needed. A member in a project can create a dataset owned by that project. This dataset can be set **private** which is visible only to other members in the same project, or **public** which is visible to all members in Biosustain Data Catalog.

```{toctree}
:maxdepth: 2
:hidden:
about
```

```{toctree}
:maxdepth: 2
:hidden:
:caption: A topic
:titlesonly:
folder_topic/article_topic
docs/article_topic
```

0 comments on commit 8697b4d

Please sign in to comment.