Skip to content

Commit 3e74d6a

Browse files
committed
typos in copier update
1 parent fba259c commit 3e74d6a

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/how-to/copier_update.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ source venv/bin/activate
1818
pip install copier
1919
```
2020

21-
NOTE: generic IOCs with a given major version number template should work with beamline repos with the same major version number template. When updating to a new major version, you may also need to update the generic IOCs it references. If this is the case it will be noted in [](../reference/changelog.md). Having said this, the two types of repo are reasonably well decoupled and we would aim to avoid this necessity. In which case update the beamline repo first and then the generic IOCs as and when new features are required.
21+
NOTE: generic IOCs with a given major version number template should work with beamline repos with the same major version number template. When updating a beamline repo to a new major version, you may also need to update the generic IOCs it references. If this is the case it will be noted in [](../reference/changelog.md). Having said this, the two types of repo are reasonably well decoupled and we would aim to avoid this necessity. In which case update the beamline repo first and then the generic IOCs as and when new features are required.
2222

2323
Updating a Beamline Repository
2424
------------------------------
@@ -43,6 +43,8 @@ For example, in version 3.4.0 the `ec-services-template` changed the way that th
4343
Updating a Generic IOC Repository
4444
---------------------------------
4545

46+
To see details of how to initially create a generic IOC repository see {any}`create_generic_ioc`.
47+
4648
To update your generic IOC repository to the latest version of the templates you should run the following command in the root of your repository:
4749

4850
```bash
@@ -77,7 +79,7 @@ In both cases you should select Y for each notice of a conflict, then resolve th
7779

7880
Using copy will mean that you get asked the template questions again, but copier is smart enough to supply your previous answers as defaults (if your repo predates copier then you will need to answer all the questions for the first time).
7981

80-
The difference from 'update' is that you will need to do the merge yourself. For example in a generic IOC you will want to restore your support module instantiations in the middle of the Dockerfile, whereas the top and bottom of the Dockerfile will should be updated by the template. Using vscode's SOURCE CONTROL pane is useful for this. The following image is an example of a Dockerfile merge:
82+
The difference from 'update' is that you will need to do the merge yourself. For example in a generic IOC you will want to restore your support module instantiations in the middle of the Dockerfile, whereas the top and bottom of the Dockerfile should be updated by the template. Using vscode's SOURCE CONTROL pane is useful for this. The following image is an example of a Dockerfile merge:
8183

8284
:::{figure} ../images/dockerfile_merge.png
8385
merging a Dockerfile after a copy copy

docs/tutorials/generic_ioc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Much like creating a new beamline we have a template project that can be used
5252
as the starting point for a new Generic IOC. Again we will create this in
5353
your personal GitHub user space.
5454

55-
55+
(create_generic_ioc)=
5656
## Steps
5757

5858
1. Go to your GitHub account home page. Click on 'Repositories' and then 'New', give your new repository the name `ioc-lakeshore340` plus a description, then click 'Create repository'.

0 commit comments

Comments
 (0)