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

Improving CLI screenshots #42

Open
sigonzal3 opened this issue Dec 8, 2020 · 2 comments
Open

Improving CLI screenshots #42

sigonzal3 opened this issue Dec 8, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@sigonzal3
Copy link

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.

@kalyanceg
Copy link
Contributor

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

@sumeshpremraj
Copy link
Collaborator

@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.

@stormic-nomad-nishant stormic-nomad-nishant added the documentation Improvements or additions to documentation label Jan 8, 2021
@linkedin linkedin deleted a comment from eddie8balltoliver Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants