Skip to content

Update pond-lake.md #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update pond-lake.md #427

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions content/resources/tutorials/pond-lake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,11 @@ Here we are going to mount your NIDM file (nidm.ttl) containing the study data u

First we install the Neurobagel Docker. Please refer to https://neurobagel.org/user_guide/getting_started/ for full details.

Start by cloning the Neurobagel recipes:
Start by cloning the Neurobagel recipes and change to the new directory:

```
git clone https://github.com/neurobagel/recipes.git
cd recipes
Comment on lines 50 to +51
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For conciseness and to ensure the commands are run together, you could combine the git clone and cd commands into a single line using &&. This also makes it easier for users to copy and paste a single command.

Suggested change
git clone https://github.com/neurobagel/recipes.git
cd recipes
git clone https://github.com/neurobagel/recipes.git && cd recipes

```

Make copies of the template configuration files to edit for your deployment (do not edit the templates themselves).
Expand All @@ -57,7 +58,7 @@ cp template.env .env
cp local_nb_nodes.template.json local_nb_nodes.json
```

In the .env file replace the placeholder value for NB_API_QUERY_URL (near line 65) with the address of the machine you are going to deploy Neurobagel on.
In the .env file replace the placeholder value for NB_API_QUERY_URL (near line 65) with the IP address of the machine you are going to deploy Neurobagel on.

```
NB_API_QUERY_URL=https://XX.XX.XX.XX
Expand All @@ -75,7 +76,7 @@ In the .env file edit the LOCAL_GRAPH_DATA section (near line 28) to list the fo
LOCAL_GRAPH_DATA=/home/user/Desktop/project_data
```

In the local_nb_nodes.json file specify a name for the local node and address:
In the local_nb_nodes.json file specify a name for the local node and address (Note only IP addresses can be used here):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This is an important note for the user. To make it more prominent and ensure it's not missed, consider using markdown emphasis like bolding.

Suggested change
In the local_nb_nodes.json file specify a name for the local node and address (Note only IP addresses can be used here):
In the local_nb_nodes.json file specify a name for the local node and address (**Note**: only IP addresses can be used here):


```
[
Expand Down
Loading