generated from enryH/notes_template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update repo to be Benchling training resouces page
- Loading branch information
Showing
3 changed files
with
66 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,17 @@ | ||
# Template for a static website using Sphinx and GitHub Pages | ||
# Static website for Benchling materials at DTU Biosustain | ||
|
||
## Instructions | ||
### Description | ||
|
||
### 1. Create new repository based on this template | ||
This repo builds a static website using Sphinx. | ||
The website contains training material and guides for researchers at DTU Biosustain, to familiarise themselves with Benchling. | ||
|
||
Create a template based on | ||
[this repository](https://github.com/enryH/notes_template) | ||
by clicking on the "Use this template" button, | ||
see instructions | ||
[here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template) | ||
|
||
- now you are already publish the site which looks identical to the template site | ||
(see it here) | ||
- jump to step 5 to do that directly. | ||
### Edit files | ||
|
||
### 2. Open in GitHub Codespaces (or locally) | ||
|
||
- go to [github.com/codespaces](https://github.com/codespaces) | ||
- create a new codespace using the forked repository | ||
|
||
> If you are done, remember to delete the codespace to not see your free credit or money | ||
> wasted. Also inactive (stopped) codespaces use storage for the last 30 days. | ||
### 3. Edit files | ||
|
||
- update in `conf.py` at least the author, project and copyright information at the top | ||
- also update two urls to your repository: | ||
```json | ||
"github_url": "https://github.com/enryh/", | ||
"repository_url": "https://github.com/enryh/notes_template", | ||
``` | ||
- write something about you in `about.md` | ||
- write articles in `folder_topic/article_topic.md` | ||
- update the `index.md` file to include new files | ||
- use [pandoc](https://pandoc.org/try/) to convert your previous files into markdown or | ||
reStructuredText | ||
|
||
### 4. Build the site locally | ||
|
||
> Have look at `.github/workflows/build_website.yaml` to see how the site is built | ||
> if you are interested. | ||
|
||
- Open a terminal (GitHub Codespaces) | ||
- install required packages from [`requirements.txt`](requirements.txt): | ||
```bash | ||
pip install -r requirements.txt | ||
``` | ||
- build the site (you could set an alias if you want): | ||
```bash | ||
sphinx-build -n -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/ | ||
``` | ||
- open the site in a browser: | ||
- install ["Live Preview" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) in Visual Studio Code | ||
- open the `_build/index.html` file in the browser (right-click, "Show Preview") | ||
|
||
### 5. Publish the site | ||
|
||
Follow | ||
[these instructions](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) | ||
to publish the website using GitHub Pages. | ||
|
||
- Select the `gh-pages` branch as the source for the GitHub Pages site (currently step 7) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,28 @@ | ||
# About | ||
|
||
> The Informatics Platform | ||
Welcome to our Benchling training resources page! | ||
|
||
We hope that here you will find the information you need to start using Benchling and master it. The resources will introduce you to various Benchling functionalities, modules and custom-built (Biosustain-specific) extensions so that you can quickly get up to speed and start using the platform! | ||
|
||
For additonal resources, you can always visit the official Benchling support page: https://help.benchling.com/hc/en-us | ||
|
||
|
||
> Our goal | ||
Through these training resources, we're here to: | ||
|
||
- Smooth out the learning curve so you can dive right into using new tools without headaches | ||
- Make capturing your scientific data easier — everything in one central spot, easy to find when you need it | ||
- Get metadata organized and standardized so everything stays clear and consistent | ||
- Boost data findability for the long haul — your data should be easy to locate years down the line! | ||
- Empower you to explore your collected data like a pro | ||
|
||
Let’s make data work for you, not the other way around! | ||
|
||
|
||
> The Team | ||
We are the software and data enthusiasts at the Novo Nordisk Foundation Center for Biosustainability! Here you will find more information about the team: https://www.biosustain.dtu.dk/technologies/informatics | ||
|
||
The objectives of the Informatic Platform (IP) team is to | ||
- Standardize, automate and accelerate data processes and analyses | ||
- Improve data findability, accessibility, interoperability, (re)usability | ||
- Build an industry level platform that covers the entire data lifecycle from raw data to insights | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters