school-of-sre icon indicating copy to clipboard operation
school-of-sre copied to clipboard

Improving CLI screenshots

Open sigonzal3 opened this issue 3 years ago • 2 comments

Hello,

I was working on a similar SRE manual and recently discovered your repo. If you allow me, I would like to contribute a few ideas, so please let me know if you have any guidelines for submitting pull requests.

As first contribution, I think that changing all CLI snippets from screenshot images to asciinema would help. Here is an example: https://asciinema.org/

Let me know your thoughts.

sigonzal3 avatar Dec 08 '20 20:12 sigonzal3

Thanks for your interest Based on eyeballing I feel asciicinema can be embedded as PNG in github pages. We should be ok as long as the content adheres to CC 4.0 license and quality standards We will come up with a cadence to handle PRs and documentation on quality standards by early next week

kalyanceg avatar Dec 09 '20 03:12 kalyanceg

@sigonzal3 can you try to create asciinema CLI snippets and open a PR? The key is to have it in PNG format so that we can embed it in the GitHub Pages static site.

sumeshpremraj avatar Dec 15 '20 04:12 sumeshpremraj