Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-07-23 23:40:44 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: update screencasts to use apply command (#2624)

Browse source 
Signed-off-by: Daniel Weiße <dw@edgeless.systems>
This commit is contained in:
Daniel Weiße 2023-11-21 16:03:11 +01:00 • committed by GitHub
parent 71dc5170a7
commit a6cf387a24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 2672 additions and 2661 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/screencasts/README.md
View file

@ -16,6 +16,7 @@ cd .. && rm -rf ./constellation
```
This will:
+ build the container
+ run the expect based scripts
+ copy recordings into the assets folder of our docs
@ -39,13 +40,11 @@ There are three different locations were styling is applied:
1. **The prompt** is styled using [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code).
More explanation and the actual color codes can be found in [Dockerfile](docker/Dockerfile).
2. **Player dimensions** are passed to the [`AsciinemaWidget`](../src/components/AsciinemaWidget/index.js)
when it's [embedded in the docs](../docs/workflows/verify-cli.md#5). Check the `asciinema-player` for a
when it's [embedded in the docs](../docs/workflows/verify-cli.md). Check the `asciinema-player` for a
[full list of options](https://github.com/asciinema/asciinema-player#options).
1. **Everything else** is [styled via CSS](../src/css/custom.css). This includes the option to build a custom
3. **Everything else** is [styled via CSS](../src/css/custom.css). This includes the option to build a custom
[player theme](https://github.com/asciinema/asciinema-player/wiki/Custom-terminal-themes).
###
## GitHub README.md
The GitHub `README.md` doesn't support embedding the JavaScript `asciinema-player`, therefore we generate an
@ -57,5 +56,9 @@ The GitHub `README.md` doesn't support embedding the JavaScript `asciinema-playe
pip3 install termtosvg
# Generate SVG. This takes ~10min, since it actually creates a cluster in GCP.
mkdir constellation
./generate-readme-svg.sh
sudo chown -R $USER:$USER ./constellation
cd constellation && constellation iam destroy
cd .. && rm -rf ./constellation
```