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

docs: add a .pdf designed cheat sheet printout #226

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

moabu
Copy link

@moabu moabu commented Jul 18, 2022

Hey @tiimgreen,

I was working on a cheat sheet for GH and I stumbled on your awesome repo so I aligned the content accordingly thinking it might be interesting to have this printout available as well.

I am happy to update any content as needed in the future and if you have any comments on the file let me know here !

This PR adds a PDF printout of the cheat sheet as in the README.

published article: https://medium.com/@moabu/the-github-cheat-sheet-df4b3e3b42a8

@Technetium1
Copy link

Please generate the PDF via CI

@moabu
Copy link
Author

moabu commented Jul 19, 2022

@Technetium1 can you elaborate ? This pdf was generated with adobe illustrator and all the figures were created from scratch so there aren't any snapshots taken.What CI process do you mean? A workflow that generates the pdf from the readme ?

@Technetium1
Copy link

@moabu Yes! If you can separate the graphics, it can automatically be created from a workflow! Then it will always have the latest info in it. PDF generation doesn't take very much of the free CI time. I'm not sure how reasonable of a request that is for a first time contribution :\

@moabu
Copy link
Author

moabu commented Jul 19, 2022

It's possible . It requires a skimmed version of the readme and the graphics of course . We can then bundle that into a flow that automatically generates the pdf printout. The readme as is has too much to generate a concise cheat sheet.

What should be done:

  • Add summary sections to the main readme that will act as the cheat sheet text for each section.
  • Write a workflow that reads the main Readme and graphics folder (to be added) to generate a nice pdf.

I'm not so sure about how pretty the output can get with this approach but it's doable.

@mcmckns
Copy link

mcmckns commented Oct 8, 2022

When "if's and but's are candy and nuts, we'll all have a MERRY CHRISTMAS!!!!...........

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

Successfully merging this pull request may close these issues.

None yet

3 participants