https://github.com/scilifelabdatacentre/dsw-appendix
A static site which provides extra documentation for users of the main DSW system
https://github.com/scilifelabdatacentre/dsw-appendix
Last synced: about 1 month ago
JSON representation
A static site which provides extra documentation for users of the main DSW system
- Host: GitHub
- URL: https://github.com/scilifelabdatacentre/dsw-appendix
- Owner: ScilifelabDataCentre
- License: other
- Created: 2019-02-28T07:37:43.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T09:00:01.000Z (about 2 months ago)
- Last Synced: 2025-03-03T10:21:28.924Z (about 2 months ago)
- Language: CSS
- Homepage:
- Size: 7.24 MB
- Stars: 1
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# SciLifeLab Data Stewardship Wizard (DSW) appendix
This repository is used for providing additional information when using SciLifeLab instances of the Data Stewardship Wizard. It is mainly used to host guides for how to use the knowledge models implemented, i.e. how to navigate the funtionality when e.g. using DSW to create a data management plan, but can also host reference pages, linked from one of the knowledge models, with in depth information regarding a certain topic.
## Instruction
1. For each topic create a sub-folder, named something appropriate (e.g. dmp-guide), in the content folder
2. If there are images, put them in folder static/img (if many images, put them in a subfolder with the same name as for the topic)
3. Create a file named `_index.md` in the new folder, and put the content/text there
4. The url for the page will be `https://dsw-appendix.scilifelab.se/`
### Step 1: Access the code
The code is hosted on [GitHub](http://github.com/), so you'll need an account.
Next, visit the code repository: [https://github.com/ScilifelabDataCentre/dsw-appendix](https://github.com/ScilifelabDataCentre/dsw-appendix)
In the top right, you'll see a button that says _"Fork"_. Click this, then select your username.
This makes a copy of the repository under your personal account that you can edit.
### Step 2a: Edit the files (online)
> This is best if you only want to make one or two minor tweaks.
> If you want to make more substantial edits over a longer time frame, we recommend editing locally (_Step 2b_).
The easiest way to edit the website files is on the GitHub website.
On the web page of your _forked_ copy of the repository, look in the `content/` directory. Go to the markdown file that you want to edit, then click the Pencil icon :pencil2: in the top right.
This opens a web-based editor where you can add and edit content. When you're finished, scroll to the bottom and fill in / submit the _"Commit changes"_ form.
You're nearly done - you can now skip to _Step 3_.
### Step 2b: Edit the files (locally)
#### Git setup
If you prefer, you can edit the website files on your computer in your favourite text editor.
Just fork the repository to your machine:
```bash
git clone [email protected]:[YOUR-USERNAME]/dsw-appendix
cd dsw-appendix
```
To make it easier to pull in changes made by others, you can add the main repository as a remote:
```bash
git remote add upstream https://github.com/ScilifelabDataCentre/dsw-appendix.git
```
Then you can fetch changes at any time from this remote:
```bash
git pull upstream main
```
When you have finished editing, commit and push to your fork:
```bash
git add .
git commit -m "My changes"
git push
```
#### Testing locally
To view your changes as they will appear in the final website, you need to install Hugo.
You can find instructions on the Hugo website: [getting-started/installing/](https://gohugo.io/getting-started/installing/)
If you're using Mac OSX, it's recommended to use [Homebrew](https://brew.sh/) -
if homebrew is already set up, installing Hugo is just a case of:
```bash
brew install hugo
```
For Windows users (additional instructions can be found [here](https://gohugo.io/getting-started/installing/#windows)):
1. Open Windows Explorer.
2. Create a new folder: C:\Hugo, assuming you want Hugo on your C drive, although this can go anywhere
3. Create a subfolder in the Hugo folder: `C:\Hugo\bin`
4. Go to the [Hugo Releases](https://github.com/gohugoio/hugo/releases) page. The latest release is announced on top. Scroll to the bottom of the release announcement to see the downloads. They’re all ZIP files. Find the Windows files near the bottom (they’re in alphabetical order, so Windows is last) – download either the 32-bit or 64-bit file depending on whether you have 32-bit or 64-bit Windows. (If you don’t know, see [here](https://esupport.trendmicro.com/en-us/home/pages/technical-support/1038680.aspx).)
5. Move the ZIP file into your `C:\Hugo\bin` folder.
6. Double-click on the ZIP file and extract its contents. Be sure to extract the contents into the same `C:\Hugo\bin` folder – Windows will do this by default unless you tell it to extract somewhere else.
7. In PowerShell or your preferred CLI, add the hugo.exe executable to your PATH by navigating to `C:\Hugo\bin` (or the location of your hugo.exe file) and use the command `set PATH=%PATH%;C:\Hugo\bin`. If the hugo command does not work after a reboot, you may have to run the command prompt as administrator.
Once Hugo is installed, simply run the following command in the repository root (dsw-appendix) directory:
```console
$ hugo serve
```
Use the URL printed at the bottom of the message (`http://localhost:1313/`) to view the site.
Every time you save a file, the page will automatically refresh in the browser.
### Step 3: Make a pull request
Once you're finished with your edits and they are committed and pushed to your forked repository, it's time to open a pull request.
You can find full documentation on the [GitHub help website](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests), however in short:
- Visit the main repository: [https://github.com/ScilifelabDataCentre/dsw-appendix](https://github.com/ScilifelabDataCentre/dsw-appendix)
- Click the button that reads _"New Pull Request"_
- Click the text link near the top that says _"compare across forks"_
- In the right-hand _"head repository"_ drop down, select your username / fork.
- If you're happy with the list of commits shown, and the diff in the _"Files Changed"_ tab, fill in a title and description and click _"Create pull request"_
Once created, a member of the website team will review your changes.
Once approved, they will be merged and deployed.
## How to get help
If in doubt, you can ask for help by emailing [[email protected]](mailto:[email protected]).
## Credits
The website was built by [SciLifeLab Data Centre](https://www.scilifelab.se/data/) and [NBIS](https://nbis.se/).