Skip to content

Commit d045276

Browse files
authored
Fix usage instructions for update_repo in template and docs (#1280)
The docs still reflected the old way to update_repo using `make`. This commit makes sure `update_repo` is used correctly without `make`.
1 parent 55c787a commit d045276

File tree

4 files changed

+9
-11
lines changed

4 files changed

+9
-11
lines changed

docs/ODKDevelopmentSnapshot.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,12 @@ If you want to use the development snapshot with your `run.sh` docker wrapper, y
2323

2424
1. `docker pull obolibrary/odkfull:dev` As mentioned above, this command installs the development snapshot
2525
1. `docker pull obolibrary/odkfull`
26-
1. Make sure your repo is up to date with the latest official release version (at least 1.3.1)
27-
1. If currently using 1.3.1: `IMAGE=odkfull:dev sh run.sh make update_repo`, else `ODK_TAG=dev sh run.sh make update_repo`
28-
1. `ODK_TAG=dev sh run.sh make update_repo` (again, if you ran it above)
26+
1. Make sure your repo is up to date with the latest official release version (at least 1.6)
27+
1. Run `ODK_TAG=dev sh run.sh update_repo` 2x.
2928

3029
You have now set your repo up to run via the development snapshot. At the top of the file, in the comments, your automatically-generated src/ontology/Makefile should now reference the development snapshot you have installed rather than the stable production release.
3130

3231
**Finally:**
3332

3433
5. You can now run any command via the `run.sh` docker wrapper. Just make sure you use the appropriate prefix depending on your version of the ODK:
35-
- If you are using ODK 1.3.1 run `IMAGE=obolibrary/odkfull:dev sh run.sh make update_repo` (or whatever other command you wanted to run).
36-
- If you are using ODK 1.3.2 or later (or the `dev` image), run: `ODK_TAG=dev sh run.sh make update_repo` (or whatever other command you wanted to run).
34+
- If you are using ODK >= 1.6 run `ODK_TAG=dev sh run.sh update_repo` (or whatever other command you wanted to run).

template/_dynamic_documentation.jinja2

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Your ODK repositories configuration is managed in `src/ontology/{{ project.id }}
256256

257257

258258
```
259-
sh run.sh make update_repo
259+
sh run.sh update_repo
260260
```
261261

262262
There are a large number of options that can be set to configure your ODK, but we will only discuss a few of them here.
@@ -419,7 +419,7 @@ components:
419419
- filename: mycomp.owl
420420
```
421421

422-
When running `sh run.sh make update_repo`, a new file `src/ontology/components/mycomp.owl` will
422+
When running `sh run.sh update_repo`, a new file `src/ontology/components/mycomp.owl` will
423423
be created which you can edit as you see fit. Typical ways to edit:
424424

425425
1. Using a ROBOT template to generate the component (see below)
@@ -819,7 +819,7 @@ We can define custom checks using [SPARQL](https://www.w3.org/TR/rdf-sparql-quer
819819
3. Update the repository so your new SPARQL check will be included in the QC.
820820

821821
```shell
822-
sh run.sh make update_repo
822+
sh run.sh update_repo
823823
```
824824
{% if project.use_dosdps -%}
825825
^^^ docs/templates/dosdp.md

template/src/ontology/Makefile.jinja2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ odkversion:
176176
config_check:
177177
@if [ "$$(tr -d '\r' < $(ONT)-odk.yaml | sha256sum | cut -c1-64)" = "$(CONFIG_HASH)" ]; then \
178178
echo "Repository is up-to-date." ; else \
179-
echo "Your ODK configuration has changed since this Makefile was generated. You may need to run 'make update_repo'." ; fi
179+
echo "Your ODK configuration has changed since this Makefile was generated. You may need to run 'sh run.sh update_repo'." ; fi
180180
{% endif %}
181181

182182
$(TMPDIR) $(REPORTDIR) $(MIRRORDIR) $(IMPORTDIR) $(COMPONENTSDIR) $(SUBSETDIR):

template/src/ontology/README-editors.md.jinja2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ documentation:
1717
to your Makefile and running:
1818

1919
```
20-
sh run.sh make update_repo
20+
sh run.sh update_repo
2121
```
2222
(Unix)
2323

2424
```
25-
run.bat make update_repo
25+
run.bat update_repo
2626
```
2727
(Windows)

0 commit comments

Comments
 (0)