You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: demo/screengrabs/README.md
+25-4Lines changed: 25 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,42 @@
1
1
## Usage
2
2
3
-
Add all commands to `commands.txt` (use `#` to disable generation of the command)
3
+
Add all commands to `demo-stacks.txt` (use `#` to disable generation of the command).
4
4
5
5
Build all colorized HTML snippets of command output by running:
6
6
7
7
```shell
8
-
make all
8
+
make build-all
9
+
```
10
+
11
+
The Makefile builds a local `atmos` binary for the captures and derives `ATMOS_RELEASE_VERSION` from the latest local release/RC tag (for example, `v1.222.0-rc.8` becomes `1.222.0`). Override it only when the next release version is known to be different:
12
+
13
+
```shell
14
+
make build-all ATMOS_RELEASE_VERSION=1.222.0
9
15
```
10
16
11
-
Then install those into `../../website/static/screengrabs' by running
17
+
The capture environment uses `TERM=xterm-256color`, `COLORTERM=truecolor`, `ATMOS_THEME=atmos`, and Atmos's documented force-color path. Do not use `TERM=dumb` or force TTY mode for normal captures; those bypass the curated terminal/color behavior that the screengrabs are meant to show.
18
+
19
+
Then install those into `../../website/src/components/Screengrabs` by running:
12
20
13
21
```shell
14
22
make install
15
23
```
16
24
17
-
All the files in `website/static/screengrabs` should be committed.
25
+
You can also build and install in one step:
26
+
27
+
```shell
28
+
make all
29
+
```
30
+
31
+
For a reproducible Linux container workflow, run:
32
+
33
+
```shell
34
+
make docker-all
35
+
```
36
+
37
+
All generated files in `website/src/components/Screengrabs` should be committed. Do not manually edit checked-in screengrab HTML; regenerate it with the script so postprocessing and validation stay consistent.
18
38
39
+
For a one-off regeneration, create a temporary manifest named `demo-stacks.txt` with only the commands you want, run `./build-all.sh demo-stacks.txt`, then copy only the resulting artifact from `artifacts/` into `website/src/components/Screengrabs`. The manifest name matters because it controls the example directory used for command execution.
19
40
20
41
Use these screengrabs then inside of any MDX documentation file, add something like this:
0 commit comments