Skip to content

Commit

Permalink
doc: fix dead link to old tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
minijackson committed Jun 5, 2024
1 parent 8c35fa0 commit d30ba53
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
4 changes: 2 additions & 2 deletions doc/ioc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Use `<consumerApp>_DEPEND_DIRS += <producerApp>`{.makefile} in your top-level `M
Meaning, not versioning an App separate from the top.
This might be justified if you don't intend to share an App in any other top.

1. First, create a top and an App, as in the [Getting Started] guide.
1. First, create a top and an App, as in the [StreamDevice tutorial].

2. Make sure to add an exception for the `exampleApp` folder at the end of the top's `.gitignore` file:

Expand All @@ -46,4 +46,4 @@ git add -N .

4. Finally, in your `flake.nix`, you can remove any input and value in `epnix.applications.apps` that refers to this directory.

[Getting Started]: ./tutorials/getting-started.md
[StreamDevice tutorial]: ./tutorials/streamdevice.md
5 changes: 2 additions & 3 deletions doc/ioc/tutorials/integration-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Integration tests

Through the [NixOS testing framework], EPNix provides a way of specifying a machine configuration, and running a Python script that can do various kind of testing.

If you created your IOC using the EPNix template, like suggested in the [Getting Started] documentation, you will see a `checks/` directory.
If you created your IOC using the EPNix template, like suggested in the [StreamDevice tutorial], you will see a `checks/` directory.
This directory should contain the integration tests you want to run.

To add an integration test to EPNix, record it in your `flake.nix` under the `epnix.checks.files` option.
Expand Down Expand Up @@ -43,7 +43,7 @@ For an overview of what you can input in the machine configuration, please refer
You can also read about the Python test script API [here][NixOS testing framework].

[NixOS testing framework]: https://nixos.org/manual/nixos/stable/index.html#sec-nixos-tests
[Getting Started]: ./getting-started.md
[StreamDevice tutorial]: ./streamdevice.md
[NixOS documentation]: https://nixos.org/manual/nixos/stable/index.html#sec-configuration-syntax

# Starting your IOC through systemd
Expand Down Expand Up @@ -115,7 +115,6 @@ You can also look at examples either in the EPNix repository under the [`checks`
```

[here]: https://search.nixos.org/options?channel=21.11&from=0&size=50&sort=alpha_asc&type=packages&query=systemd.services.
[epics-systemd]: https://github.com/minijackson/epics-systemd
[Packaging Python scripts]: ../guides/testing/packaging-python-scripts.md
[NixOS tests documentation]: https://nixos.org/manual/nixos/stable/index.html#sec-nixos-tests
[`checks` folder]: https://github.com/epics-extensions/epnix/tree/master/checks
Expand Down

0 comments on commit d30ba53

Please sign in to comment.