Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recorded demos #86

Open
hjoliver opened this issue Oct 8, 2019 · 10 comments
Open

Recorded demos #86

hjoliver opened this issue Oct 8, 2019 · 10 comments

Comments

@hjoliver
Copy link
Member

hjoliver commented Oct 8, 2019

We should consider recording

  • UI demos as animated gif or webm
    • @kinow uses byzanz on ubuntu (but the package or source seems to be very hard to find for other platforms, maybe be a dead project?)
    • I've installed peek
  • cut-n-paste-able console demos with https://asciinema.org/ - very cool
@kinow
Copy link
Member

kinow commented Oct 8, 2019

Let me know which one works best for you. asciinema looks limited to only console apps. But peek looks interesting!

@hjoliver
Copy link
Member Author

hjoliver commented Oct 8, 2019

For the record, how to install peek on Centos 7 (sudo required):

  • clone peek off github
  • yum install:
    • vala, meson and ninja-build
    • txt2man
    • gtk3-devel (else gtk-3.0 not found during the build)
  • follow the simple build instructions for peek, in BUILD_NOTES.md
    • a locally installed executable (via ninja-build install) resulted in core dump due to some gnome schema problem, but system install under /usr worked fine
  • had to install ffmpeg to get gif recording to work (but .webm worked out of the box)

@hjoliver
Copy link
Member Author

hjoliver commented Oct 8, 2019

Let me know which one works best for you. asciinema looks limited to only console apps. But peek looks interesting!

Peek seems to work perfectly, demo coming...

Yes asciinema records and plays console only -but the playback is text (not video!) so users can cut-and-paste as well as pause and rewind. We could use this e.g. to show exactly how to install Cylc 8 via conda, or to demo various CLI operations.

@kinow
Copy link
Member

kinow commented Oct 8, 2019

The screencasts won't work for cylc-doc PDF version. Should we have a section that appears on the version for web only, or add it to the website?

@hjoliver
Copy link
Member Author

hjoliver commented Oct 8, 2019

(My impression is, no one under the age of 63 prefers PDF anymore, for technical docs).

@hjoliver
Copy link
Member Author

hjoliver commented Oct 8, 2019

Demo recorded with peek (130k gif):

Peek 2019-10-08 15-21

@kinow
Copy link
Member

kinow commented Oct 8, 2019

Looking great! And all good in dropping the PDF's for me. If you use the websockets branches, there should be no delay on showing the workflows 🤞😁

@hjoliver
Copy link
Member Author

hjoliver commented Oct 8, 2019

If you use the websockets branches, there should be no delay on showing the workflows crossed_fingers

I'll replace the screencast after doing that, later 😁

@kinow
Copy link
Member

kinow commented Oct 8, 2019

BTW, for cylc ui issues, these demos/screencasts would be really useful too (even if only us or few users use it)

@oliver-sanders
Copy link
Member

Some demos are now present in the interventions section, see #626

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants