Tutorials Fixup #186
Tutorials Fixup #186
Conversation
The make command outputs repeated warnings of this form:
perl: warning: Setting locale failed.
perl: warning: Please check that your locale settings:
LANGUAGE = (unset),
LC_ALL = (unset),
LANG = "en_US.UTF-8"
are supported and installed on your system.
perl: warning: Falling back to the standard locale ("C").
The path is already mounted in the container
On my machine the Phoebus container seems to load a screen from a previous step of the tutorials as well as the expected "auto-generated/index.bob"
These are referred to by number in various places, so should have user-visible numbering.
The auto port forwarding does not work in "output" or "hybrid" modes
This is the expected state of the repo for various future tutorials
There is no "Title" for an Image, only a "Name".
This is likely a topic of much confusion due to where each container is mounting the relevant folders, so probably deserves further explanation or simplification.
No-where else in the docs are there references to "deploy-local"
Without this, double dashes ("--") get converted into an em-dash ("–")
which means copy-pasting no longer works
This appears to be an incomplete duplicate of the text immediately below
docs/tutorials/dev_container.md
Outdated
There was a problem hiding this comment.
What was the reason for removing this?
There was a problem hiding this comment.
According to my commit notes, it had already been mounted earlier in the tutorials. However, skimming back through them I can't actually find where that is said. I can instead change the wording to something like "if it isn't already mounted, mount the /epics folder"?
There was a problem hiding this comment.
although mount is not the word I'd use - it's add folder to workspace I think
There was a problem hiding this comment.
Rewritten in f02b0be
docs/how-to/copier_update.md
Outdated
| @@ -35,7 +35,7 @@ You can supply the VERSION_NUMBER of the template you want or omit the `-r` opti | |||
|
|
|||
| This will update your project in place. You should then inspect the changes using git (the source control pane in vscode is excellent for this purpose) and commit them to your repository. Once you are happy with the changes you can test them by re-deploying some of your IOC instances. When everything is working you can push the changes to your repository. | |||
|
|
|||
| The template comes with an example IOC called xxxx-ea-test-01. You are free to delete this if you don't want it. However, we recommend keeping that IOC as it is a good reference for what changes might be needed in your own IOC instances. | |||
| The template comes with an example IOC called `.ioc_template`. You are free to delete this if you don't want it. However, we recommend keeping that IOC as it is a good reference for what changes might be needed in your own IOC instances. | |||
There was a problem hiding this comment.
This text should be changed because it is no longer a functioning example, rather a template.
There was a problem hiding this comment.
How does 73c1af2 sound?
There was a problem hiding this comment.
In fact I think this paragraph could be deleted as the use of .ioc_template is described elsewhere.
There was a problem hiding this comment.
Deleted in 2419be8
There was a problem hiding this comment.
Yay - deleting the paragraph is better. Deleting the .ioc_template is not a good idea as it will track changes to what services folders for IOCs should look like through changes in the framework.
Thanks and merging!
I can no longer find why I thought I should remove this section! It doesn't hurt to tell the reader to add the folder again.
AlexanderWells-diamond
force-pushed
the
alexw/minor_corrections
branch
from
7000d01 to
73c1af2
Compare
It's documented elsewhere
AlexanderWells-diamond
force-pushed
the
alexw/minor_corrections
branch
from
73c1af2 to
2419be8
Compare
A set of changes made while going through the Tutorials. Also includes some minor typo/grammar/etc fixes on documentation in other sections.
Most changes have an explanation in their commit message.