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

Add cheatsheet for attendees #541

Open
2 of 4 tasks
alicetragedy opened this issue Sep 14, 2014 · 29 comments
Open
2 of 4 tasks

Add cheatsheet for attendees #541

alicetragedy opened this issue Sep 14, 2014 · 29 comments
Assignees

Comments

@alicetragedy
Copy link
Member

I think it's good for attendees to have something to take home with them (and maybe something to glance at while at the workshop) - while we do some rework/redesign of the booklet, I could add the one-page-cheatsheet we made for RG Linz (git, general command line, rails commands) to the materials for the organisers to download.

  • InDesign file
  • PDF (for easy printing)
  • a markdown or text file with the actual content that can be easily copied and pasted
  • a style guide (colors, possible typefaces and font sizes, etc.. and helpful tips)
@lindaliukas
Copy link
Member

Sounds wonderful!

On Sun, Sep 14, 2014 at 6:19 PM, alicetragedy notifications@github.com
wrote:

I think it's good for attendees to have something to take home with them
(and maybe something to glance at while at the workshop) - while we do some
rework/redesign of the booklet, I could add the one-page-cheatsheet we made
for RG Linz (git, general command line, rails commands) to the materials
for the organisers to download.


Reply to this email directly or view it on GitHub
#541.

@keikoro
Copy link
Contributor

keikoro commented Sep 16, 2014

Cheat sheets are great! The one we had for the 1st Rails Girls Vienna event was unfortunately (well, "unfortunately") done by a sponsor at another event, so we couldn't just put it online to share it.

I think it'd be super cool if you also added an editable version of the document to the private RG repo so that other organisers can adapt it for their local workshops (translate it, add to it etc.).

@sareg0
Copy link
Contributor

sareg0 commented Sep 16, 2014

Perhaps a markdown file? Cheat sheets are awesome, each chapter can
decorate it if they like. It's a great souvenir to hang on the wall

On Tuesday, September 16, 2014, Kay notifications@github.com wrote:

Cheat sheets are great! The one we had for the 1st Rails Girls Vienna
event was unfortunately (well, "unfortunately") done by a sponsor at
another event, so we couldn't just put it online to share it.

I think it'd be super cool if you also added an editable version of the
document to the private RG repo so that other organisers can adapt it for
their local workshops (translate it, add to it etc.).


Reply to this email directly or view it on GitHub
#541 (comment)
.

@alicetragedy
Copy link
Member Author

thanks for the feedback - the one I made was in InDesign (so the output was a PDF) but I'm sure I could change that, since that's not necessarily a program everyone has access to. Maybe adding both (editable + non-editable) might be cool, that way we also have a version that's ready & optimized for printing. I've never made "pretty" markdown files that didn't rely on some sort of template (eg. for a blog) so I'm not really sure what's the best way to do it (adding bg color, making columns, etc..) but I'll try to find out!
@sareg0 do you have experience with that?

@keikoro
Copy link
Contributor

keikoro commented Sep 16, 2014

True, not everybody has access to InDesign, but on the other hand, not all organisers are techies/have worked with Markdown before and might not want to spend the time looking into it (but some might have a background in graphics/design) so I think providing both would be a good idea. If given a choice, I, personally, would take InDesign over Markdown for things to be printed any day! ^^

And yes, a ready-to-print version - or versions... over time - would definitely be good to have!

@sareg0
Copy link
Contributor

sareg0 commented Sep 17, 2014

That's right... Markdown is harder to make look nice... No one file type
will be 100% accesible (i.e. not everyone uses Google docs, or PS, or
markdown). I guess if there's a style guide, and a PDF, then people can use
whatever program they have access to; powerpoint, word etc etc. As lons as
the content is there, they can copy and paste it into any document, or just
use the static copy, that we can try to keep updated in a central place too
:)

On Tue, Sep 16, 2014 at 4:00 PM, Kay notifications@github.com wrote:

True, not everybody has access to InDesign, but on the other hand, not all
organisers are techies/have worked with Markdown before and might not want
to spend the time looking into it (but some might have a background in
graphics/design) so I think providing both would be a good idea. If given a
choice, I, personally, would take InDesign over Markdown for things to be
printed any day! ^^

And yes, a ready-to-print version - or versions... over time - would
definitely be good to have!


Reply to this email directly or view it on GitHub
#541 (comment)
.

@keikoro
Copy link
Contributor

keikoro commented Sep 17, 2014

I'd still find it great if any originals were shared too - if @alicetragedy doesn't mind, that is. Less work for minor changes. (:

@alicetragedy
Copy link
Member Author

I definitely don't mind @kerstin - not a problem. So that means I'll put together:

  • InDesign file
  • PDF (for easy printing)
  • a markdown or text file with the actual content that can be easily copied and pasted
  • a style guide (colors, possible typefaces and font sizes, etc.. and helpful tips)

@keikoro
Copy link
Contributor

keikoro commented Sep 17, 2014

Sounds verrry cool, thanks for doing this!

@alicetragedy
Copy link
Member Author

No problem!
Then we can test it on our Rails Girls Vienna attendees ;)

@keikoro
Copy link
Contributor

keikoro commented Sep 17, 2014

Totally! :D

@sareg0
Copy link
Contributor

sareg0 commented Sep 17, 2014

sounds great Laura!

@joermungandr
Copy link

Is it still actual? ;-)

@keikoro
Copy link
Contributor

keikoro commented Oct 2, 2014

Hey Steven, are you asking if this is still ongoing? There might not have been any super recent updates, but I''m certain that @alicetragedy is still on it. (: Our event (referred to above) is set to take place mid-November, so there's still quite a bit of time left and we're not in a big hurry. ^^

@alicetragedy
Copy link
Member Author

yes, sorry if this has been dragged on on my side. I'm hoping to work on this over the weekend (basically that means mostly the markdown / text and the style guide, as well as changes in the existing InDesign file so it can be used for all events). Don't despair, @joermungandr! ;)

@alicetragedy
Copy link
Member Author

@lindaliukas @kerstin @sareg0 I'm kicking myself in the butt to get this done this weekend. A question arose: Should I put the printed materials in a public repo within the railsgirls organisation? WDYT?Suggestions welcome, I don't know what the best practice would be here :)
(I understand that the workbook gets its own repo, as it will be an interactive site.. but I am not sure about the rest, I don't want to clutter everything). Maybe having a repo for printed materials would be a good idea to have everything in one place - with a small readme for instructions and list of contents.

@sareg0
Copy link
Contributor

sareg0 commented Oct 3, 2014

I'm not sure what best practice would be apart from putting it here? https://speakerdeck.com/railsgirls

@keikoro
Copy link
Contributor

keikoro commented Oct 3, 2014

I like the idea of a repo, or maybe a separate folder in an existing repository.

That could replace Speakerdeck as a place where all these materials are stored (which, tbh, I thought was a weird choice for storing graphics to begin with). Speakerdeck won't work for anything that isn't a PDF, @sareg0 - it's really meant for presentations. (:

GitHub, of course, is mostly meant for code, and not for most other file formats and especially large files (see https://help.github.com/articles/what-is-my-disk-quota/ + https://help.github.com/articles/working-with-large-files/), but that'd mean creating yet another place to store stuff, which sounds a bit impractical...

Whether it should be public or private probably depends on which other materials would go into it?

@alicetragedy
Copy link
Member Author

@kerstin @sareg0 yeah that's exactly the problem I am having, we can't put anything on Speakerdeck other than pdfs, which defeats the purpose of writing a text/markdown file and of storing the original InDesign file for the cheat sheet. The InDesign file, by the way, is 1.3MB (:

I have everything ready, except for the style guide (which could anyway use some input/feedback) so whenever we decide where the stuff goes, I can add it/send it to someone for adding/send a pull request...

@keikoro
Copy link
Contributor

keikoro commented Oct 3, 2014

Hmm, maybe ask on the mailing list for input/opinions? I'm sure there are a lot more people reading there than the issues here (not everyone has access to this repo and some will have notifications disabled or sent to different e-mail addresses).

@sareg0
Copy link
Contributor

sareg0 commented Oct 4, 2014

Could the cheatsheet work the same way that the workbook does?
Markdown files, that can be converted into PDF for easy printing?

https://github.com/railsgirls/workbook

@alicetragedy
Copy link
Member Author

@sareg0 I guess it could, but it would mean some extra work (since I have no experience with converting markdown into pdf at all, I don't know how well md works with "fancy" stuff). I think the whole point of markdown is to be as easy to use as possible, so you can't really eg. use your own fonts, change font color or size - at least not out of the box/not that I know, but as I said above I have no experience with that. :)
Basically I just wanted to get that stuff I already have out as soon as possible and make it easy for people to change/contribute, rather than starting from scratch. :)

But I asked for input on the mailing list and I think for now I can just add it all to the assets/materials folder as @phenriettak suggested, or maybe to the workbook repo as you did? (just don't want to add extra 💩 in there since I don't know what's planned for the workbook exactly yet). If someone wants to do a version in markdown that can be easily turned into a pdf for printing, that would be great. but you are right Sara, I will reference this issue there.

@alicetragedy
Copy link
Member Author

ok, you'll find the first couple of files for the cheatsheet here: https://github.com/railsgirls/railsgirls/tree/master/assets/materials/cheatsheet

I might have to make a few changes to the markdown file, and I'll add the style guide and original InDesign file tomorrow. ✔️

@lindaliukas
Copy link
Member

Yeah - Speakerdeck is by no way ideal, it was just something I dumped the
presentations (evenI think before there was Github). (And P.S LOVE LOVE all
the work that is happening here <3)

Linda

www.lindaliukas.fi
Tel: +358 41 51 434 05
Skype: linda.liukas
Twitter: lindaliukas

On Sat, Oct 4, 2014 at 9:54 PM, alicetragedy notifications@github.com
wrote:

ok, you'll find the first couple of files for the cheatsheet here:
https://github.com/railsgirls/railsgirls/tree/master/assets/materials/cheatsheet

I might have to make a few changes to the markdown file, and I'll add the
style guide and original InDesign file tomorrow. [image:
✔️]


Reply to this email directly or view it on GitHub
#541 (comment)
.

@joermungandr
Copy link

If there is anything I can do, just message me :-)

@phenriettak
Copy link
Contributor

@ksaa here some more stuff too

@alicetragedy
Copy link
Member Author

Sorry, I've completely left this hanging up in the air.. I'll have time to finish this completely over the Christmas break. thank you @joermungandr for offering to help! Maybe once the eg. style guide is up, you'd like to help reviewing it.. and of course you can already go over the PDF of the cheatsheet I posted above and see if there's anything important missing (I couldn't add everything, unfortunately, because I wanted to keep it simple for the organisers - this way you can print the document with a normal printer and don't have to worry about page numbers and staples)

@phenriettak
Copy link
Contributor

@alicetragedy hey no worries! I will also have to work on the booklet's finalisation during the xmas break, and also have not got any other materials yet so don't worry. :)

@joermungandr
Copy link

Yes, sure! I can review it!

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

No branches or pull requests

6 participants