Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ repos:
rev: v2.4.1
hooks:
- id: codespell
# - repo: https://github.com/shellcheck-py/shellcheck-py
# rev: v0.11.0.1
# hooks:
# - id: shellcheck
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.47.0
hooks:
Expand Down
6 changes: 2 additions & 4 deletions docs/user_guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,7 @@ Docker Compose recipe and template configuration files for setting up a local Ne
Clone the `recipes` repository from GitHub and navigate into the cloned local repo.

```bash
git clone https://github.com/neurobagel/recipes.git
cd recipes
--8<-- "snippets/user_guide/clone_recipe.sh"
```

### Copy the template files
Expand All @@ -107,8 +106,7 @@ Make copies of the template configuration files
to use for your deployment.

```bash
cp template.env .env
cp local_nb_nodes.template.json local_nb_nodes.json
--8<-- "snippets/user_guide/copy_template_files.sh"
```

You can leave these files unchanged for a local test deployment.
Expand Down
20 changes: 8 additions & 12 deletions docs/user_guide/production_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,27 +94,23 @@ specific combinations of services (listed below), depending on your use case.

Make a fresh clone of the `recipes` repository in a location of your choice.

```bash
git clone https://github.com/neurobagel/recipes.git recipes
```

!!! tip "Consider changing `recipes` to a name you will recognize in the future"

Then navigate into this directory for the remaining steps.

```bash
cd recipes
--8<-- "snippets/user_guide/clone_recipe.sh"
```

#### Copy the template configuration files

The recipe repository includes templates of files for configuring your deployment: `.env` and
`local_nb_nodes.json`. Copy and rename these templates, but do not edit
the templates themselves.
The recipe repository includes templates of files for configuring your deployment: `.env` and
`local_nb_nodes.json`.

Navigate into this directory for the remaining steps.
Copy and rename these templates,
but do not edit the templates themselves.

```bash
cp template.env .env
cp local_nb_nodes.template.json local_nb_nodes.json
--8<-- "snippets/user_guide/copy_template_files.sh"
```

### Proxy server
Expand Down
6 changes: 6 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ theme:
text: Roboto
code: Roboto Mono
repo_url: https://github.com/neurobagel/documentation
docs_dir: docs

# For docs navigation definition, see docs/.nav.yml
# See also README for more info on how to add new pages/sections
Expand Down Expand Up @@ -107,3 +108,8 @@ extra:

extra_css:
- stylesheets/extra.css


watch:
- docs
- snippets
1 change: 1 addition & 0 deletions snippets/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
recipes
6 changes: 6 additions & 0 deletions snippets/makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
clean:
rm -fr recipes

run_user_guide: clean
bash user_guide/clone_recipe.sh
bash user_guide/copy_template_files.sh
2 changes: 2 additions & 0 deletions snippets/user_guide/clone_recipe.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
git clone https://github.com/neurobagel/recipes.git

3 changes: 3 additions & 0 deletions snippets/user_guide/copy_template_files.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
cd recipes
cp template.env .env
cp local_nb_nodes.template.json local_nb_nodes.json
Loading