Skip to content

Commit

Permalink
Merge pull request #501 from nfdi4plants/relaunch-edits
Browse files Browse the repository at this point in the history
Relaunch edits
  • Loading branch information
Brilator authored Nov 6, 2024
2 parents 505a139 + 2a5c921 commit 2ee215b
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 30 deletions.
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Thank you for contributing to the DataPLANT Knowledge Base :rocket:

## Please make sure that

- [ ] your pull request has a **good title**,
- [ ] you add a short description below to summarize your changes,
- [ ] the contents and images you add, are allowed to be shared publicly and - if applicable - reference the source properly,
- [ ] you read the [contribution guide](https://github.com/nfdi4plants/nfdi4plants.knowledgebase/blob/main/CONTRIBUTING.md),
- [ ] you tested your changes locally via `npm run dev` and `npm run build`

If you are unsure, you can also label your PR as draft.

## Description
18 changes: 16 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,20 @@ Please explore the sections on the left to find guides on:
## Article cross-references

Avoid relative paths when cross-referencing another knowledge base article.
Instead, use references starting from the `docs` folder as root, e.g.
Instead, use references starting from the `docs` folder as root and add `/nfdi4plants.knowledgebase/`, e.g.

[wiki associated to the ARC](/datahub/datahub-arc-wiki)
```md
[wiki associated to the ARC](/nfdi4plants.knowledgebase/datahub/datahub-arc-wiki)
```

## Test-build locally

On a fresh clone of this repository, run

1. `npm install` to install the latest package dependencies
2. `npm run dev` to render the knowledge base in watch mode

### Check for dead links

Especially when editing / adding / moving files, make sure to test build the site via `npm run build`.
This validates all links (cross-references between articles and image links).
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ For all other contributions, please refer to the [contribution guide](https://gi

This work is licensed under a
[Creative Commons Attribution 4.0 International License][cc-by].

[cc-by]: http://creativecommons.org/licenses/by/4.0/
[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg
15 changes: 7 additions & 8 deletions src/content/docs/datahub/datahub-generate-pat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,13 @@ sidebar:

import { Steps } from '@astrojs/starlight/components';

:::note[About this guide]
This guide shows you how to generate a Personal Access Token (PAT). The PAT can be used to authenticate your local machine to communicate with your DataHUB account.
:::

:::note
You need to do this only once per machine (unless you specify an expiration date)
:::

<Steps>

1. Sign in to the [DataHUB](https://git.nfdi4plants.org/)
2. Go to the [Access Tokens](https://git.nfdi4plants.org/-/profile/personal_access_tokens) settings
2. Navigate to the [user settings](/nfdi4plants.knowledgebase/datahub/datahub-user-settings)
2. Go to the [Access Tokens](https://git.nfdi4plants.org/-/user_settings/personal_access_tokens) settings
3. Fill all required information:
- Token name: e.g. the name of the machine to be linked ("Office PC") (1)
- Expiration date (optional) (2)
Expand All @@ -33,4 +28,8 @@ You need to do this only once per machine (unless you specify an expiration date

![](@images/datahub/datahub-access-token02.drawio.png)

</Steps>
</Steps>

:::note
You need to do this only once per machine (unless you specify an expiration date)
:::
22 changes: 2 additions & 20 deletions src/content/docs/resources/galaxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,14 @@ authors:

import { Steps } from '@astrojs/starlight/components';

:::note[About this guide]
In this guide we introduce how to access ARCs from Galaxy. To access the data of an ARC, you must first provide a DataHUB access token in Galaxy, which is used to authenticate Galaxy to DataHUB. To create a new token and add it to [Galaxy](https://usegalaxy.eu/), you can proceed as described below.
:::

:::tip[Before we can start]
- You have created an ARC before using the [ARC Commander](/nfdi4plants.knowledgebase/arc-commander) or [ARCitect](/nfdi4plants.knowledgebase/arcitect)
- You have a [DataPLANT](https://register.nfdi4plants.org) account
:::

## Create an access token in DataHUB

{/* TODO : duplicated guide on PAT */}
import DataHubPat from '../datahub/datahub-generate-pat.mdx'

![image](@images/guides/arcfs/arcfs-kb-01-blurred-marked.png)
![image](@images/guides/arcfs/arcfs-kb-02-blurred-marked.png)

<Steps>

1. Open the dropdown menu for your personal settings.
2. Open the "Preferences" menu.
3. Change to tab "Access Tokens".
4. Choose a name for the new token.
5. Set a expiration date.
6. Select the authorization scope.

</Steps>
<DataHubPat />

:::tip
Only the scopes "api" (for write access) and "read_api" (for read access) are relevant for ARCfs.
Expand Down

0 comments on commit 2ee215b

Please sign in to comment.