#179 Help with cheatsheet design/template
Closed: Fixed None Opened 13 years ago by james.

I wanted to do something like the following, but for yum:

    http://en.opensuse.org/File:Zypper-cheat-sheet-1.pdf
    http://en.opensuse.org/File:Zypper-cheat-sheet-2.pdf

...and was told you'd be the people to ask about creating something I can put the data into?


This sounds like a really fun task. Could you tell us a little bit more about it?

I assume the data won't change very often, so do you think it's possible to give us the data (and maybe an idea for the layout/groups) first and then let us organize it on the page?

A random text brain dump I'd done is at:

http://james.fedorapeople.org/yum/cheatsheet.txt

...which is mostly notes for me, so I appologise in advance if it's unreadable for people not me :).

My guess at something to start with was to have 2 cheatsheet pages, the first being "basic" stuff for new users (although may contain some tidbits that people already using it don't know atm).
The second maybe something with the plugins/etc. ... that much less people are going to know.

I'd figured something a4/letter size should be good, but I'm not sure how big the text is better being ... or how much space should be taken by "blocking" the text. So I'm really not sure how much text should go on each page (looking for input from someone with style :).

I'd also had some ideas about being able to do "compression" (Eg. install/remove/upgrade/downgrade all take very similar arguments -- see above) ... but there's obviously some tradeoff there between compression and "unintelligible" (again, any advice is appreciated :).

So, in short, it all depends on how much work you want to do ... anything from just "use this .blah file, and create these boxes like so and put text into them", to taking my insane technical mumble and creating a work of beauty ... all would be much appreciated.

That sounds great, I'll assign this ticket to me.

So, what I think is a good plan...

  • you give me a few samples of sections with a bunch of commands (complete with all the information for those, including comments)
  • I take a look at these and put together a first draft
  • once I have something satisfying, you can work on the rest of the sections and commands (which will be easier, because then we can see how much space it'll take, etc)
  • you send the "final" content to me and I integrate that into the design

So for the first one, the samples... I think what you said about compression is very interesting and we can definitely make that work with proper alignment and coloring. :)

It'd be great if you could include some of those "compressable" commands in the samples, so I can try to create something cool.

What do you think?

Sounds, great ... so you want me to just email you part of the text above with some comments?

Sure, sounds good. I'm also 'schendje' on IRC if you want to reach me there.

I've been away for over a week, but here's a first shot at this:

http://schendje.fedorapeople.org/yumcheatsheet/try1.png

It's still a big WIP. I'll keep working on it to find the right layout.

Name: James Antill, email: james.antill@redhat.com has been contacted for feedback on the WIP.

So, sorry ... I didn't know I needed to comment at the time (and didn't want to say bad things about a WIP), and then I forgot about it ... crazy few months!

So ... some comments, I understand it's a WIP ...

  1. Looks quite pretty ... but change of BG from dark blue to white, with the same text colour, makes it a bit hard to read.

  2. Repeating all the "yum install" bits seems like it's wasting a lot of space.

  3. "yum install @books" should not have the '=' char. there.

  4. "yum remove" is probably a copy/paste error?

  5. upgrade/downgrade/reinstall/distro-sync ... can we line up the commands? Again, maybe drop yum and <package> for each one somehow ... actually can we line up all the "command <arg>" columns?

  6. Can we split "yum list" out like install/remove ... maybe use that to show what "<package>" means? ... if this could stop people doing "yum list | grep foo", that would be a huge win :)

  7. "yum list install 'yum'" should be "yum list installed 'yum'" ... this is almost certainly my fault :).

Noted! Thanks for the feedback. :)

I'll work some more on this and let you know how it goes.

Log in to comment on this ticket.

Metadata