low-code-jupyter-docs

This repository contains the documentation for Domino Code Assist.

The live documentation is at https://dominodatalab.github.io/domino-code-assist-docs/.

Develop documentation

Install dependencies:

$ pip install -r requirements.txt

Start server

Start mkdocs

$ mkdocs serve
INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  Documentation built in 0.23 seconds
INFO     -  [13:51:27] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [13:51:27] Serving on http://127.0.0.1:8000/

Now you can edit the markdown files, and the documentation page should reload.

• Mkdocs: https://www.mkdocs.org/
• Theme: Material for MkDocs
  • https://squidfunk.github.io/mkdocs-material/
  • https://squidfunk.github.io/mkdocs-material/reference/annotations/

Publish

Using mike to handle versions.

Generating video/screenshots

This is required when Code Assist looks different.

$ conda env create -f environment.yml
$ conda activate lca-docs

1. Start a jupyter notebook server

   $ jupyter notebook --notebook-dir=notebooks --NotebookApp.token='' --port=11111 --no-browser

2. Install dependencies/playwright

   $ playwright install

3. Run load session

   $ python capture.py load-csv

4. To run more available sessions, see:

   $ python capture.py --help

Some scripts also general 'general' images (screenshots of buttons, icon etc). If these are performed while recording a video, the video will show a flicker. Instead run the script once with --general-screenshots, and for the video without.

To run all:

$ python capture.py load-csv &&\
 python capture.py load-csv --no-general-screenshots &&\
 python capture.py audio load-csv --no-general-screenshots &&\
 python capture.py load-redshift &&\
 python capture.py load-redshift --no-general-screenshots &&\
 python capture.py load-redshift-sql &&\
 python capture.py load-snowflake &&\
 python capture.py transform &&\
 python capture.py transform --no-general-screenshots &&\
 python capture.py audio transform &&\
 python capture.py viz-scatter &&\
 python capture.py audio viz-scatter &&\
 python capture.py app-create &&\
 python capture.py app-create --no-general-screenshots &&\
 python capture.py app-create --no-general-screenshots &&\
 python capture.py overview &&\
 python capture.py audio overview &&\
 python capture.py audio deploy &&\
 echo "done"

Updating audio

E.g. for load-csv see also the ./scripts/README.md:

• $ python capture.py load-csv --no-general-screenshots
• Upload script/load-csv.txt to murf.ai using voice 'Amalia'.
• Click Export -> 'Split by Sub-Blocks', 'High', 'Stereo' -> Download and put the files in audio/load-csv
• Run $ python capture.py load-csv --no-general-screenshots again so we get the right timing (saved in audio/load-csv.json)
• Run $ python capture.py audio load-csv to insert the audio into the video.

Consistent Window Size

Find the relevant window ID.

$ wmctrl -l
0x0400000a  0 propane Terminal
0x06a00056 -1 propane DBeaver 22.3.2 - <localhost> Script-62 
0x03a0110f -1 propane Domino — Mozilla Firefox

Resize the window.

$ wmctrl -ir 0x03a0110f -e 0,0,0,1252,1087

Converting MP4 to GIF

ffmpeg -i screencast.mp4  -r 5 'frames/frame-%03d.png'
gifski -o screencast.gif --fps 5 --width 1280 --quality 100 frames/*.png

Recording Videos

1. Launch Kazam.
2. Browser to fullscreen.
3. Start Kazam via Windows-Ctrl-R.
4. Do demo.
5. Stop Kazam via Windows-Ctrl-F.