Skip to content

Commit

Permalink
Merge branch 'main' into refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
bazile-clyde committed Apr 25, 2023
2 parents b7d2e89 + 8e10d18 commit 8a7e436
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions canaries/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The files in this directory serve as both example code for displaying image streams and scripts for our canary releases.

A **canary release** (or canary launch or canary deployment) allows developers to have features incrementally tested by a small set of users[^1]. To set up these canaries on Debian-based Linux distribution follow the steps below.
A **canary release** (or canary launch or canary deployment) allows developers to have features incrementally tested by a small set of users[^1]. To set up these canaries on a Debian-based Linux distribution follow the steps below.

#### Install Python3 dependencies
```bash
Expand Down Expand Up @@ -28,7 +28,7 @@ ExecStart=<needs absolute path to Python3, use $(which python3)> <path to vision
WantedBy=multi-user.target
```
#### Create a secrets file
This file contains the address the payload arguments for both canary scripts. It MUST be in the location below
This file contains secrets/arguments for both canary scripts. It MUST be in the location below.
```bash
$ cat ~/.canary_secrets.json
{
Expand All @@ -55,4 +55,4 @@ $ systemctl --user status canary.service
```


[^1]: https://en.wikipedia.org/wiki/Feature_toggle#Canary_release
[^1]: https://en.wikipedia.org/wiki/Feature_toggle#Canary_release

0 comments on commit 8a7e436

Please sign in to comment.