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

Added Getting Started with Markdown lesson. #61

Merged
merged 4 commits into from Nov 24, 2015

Conversation

Projects
None yet
8 participants
@ssimpkin
Contributor

ssimpkin commented Dec 9, 2014

First go at beginner Markdown lesson -- suggestions welcomed. Any ideas for wrapping it up better are especially appreciated.

@wcaleb

This comment has been minimized.

wcaleb commented on lessons/getting-started-with-markdown.md in 5eb0634 Dec 9, 2014

Perhaps add links to these text editors?

@wcaleb

This comment has been minimized.

wcaleb commented on lessons/getting-started-with-markdown.md in 5eb0634 Dec 9, 2014

Perhaps mention that our Programming Historian lessons are also written in Markdown, so after lesson people will be able to draft lessons for our site.

@williamjturkel

This comment has been minimized.

Contributor

williamjturkel commented Dec 11, 2014

I think this is a nice and clear Markdown intro. I think we do want something about doing GitHub favoured tables: I used them recently in a PH lesson. It does taper off a bit at the end but I'm not sure how to best wrap it up... perhaps with a paragraph about other uses for Markdown in DH?

@acrymble

This comment has been minimized.

Contributor

acrymble commented Dec 11, 2014

Maybe end with a paragraph on limits. (Most journals wont know what to do with it) and then a paragraph reiterating its value, before finishing with a historian-ey example? Maybe a structured short primary source?

@wcaleb

This comment has been minimized.

Contributor

wcaleb commented Mar 27, 2015

Are we ready to add this lesson? Just noticing we never merged the pull request. @williamjturkel @acrymble

@ssimpkin

This comment has been minimized.

Contributor

ssimpkin commented Mar 27, 2015

Close, not quite! I'm having a colleague read through and zest up the content a bit. Still feel it could use some tweaking.

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented May 19, 2015

Just pinging as I see this is still outstanding: how are things going, @ssimpkin? I think this'll be a fantastic addition for historians (especially those who want to write for Programming Historian!).

@jbfink

This comment has been minimized.

jbfink commented May 19, 2015

Don't blame @ssimpkin on this one, I've fallen down on looking at the dang thing and she asked me like twenty years ago. Am going to do it today.

@ianmilligan1 ianmilligan1 self-assigned this May 21, 2015

@wcaleb

This comment has been minimized.

Contributor

wcaleb commented May 21, 2015

This has been added to the Lesson Pipeline wiki.

@wcaleb wcaleb added the submission label Jun 1, 2015

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Aug 24, 2015

Just checking in again like the gadfly that I am. How go things?

@ssimpkin

This comment has been minimized.

Contributor

ssimpkin commented Aug 25, 2015

They go! John had a look over here and the biggest change was a switch over to another browser-based md editor. I'm happy with it as a public intro, but feel that the wiki "instructions for authors" page is better suited for teaching people the ropes as lesson contributors.

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Aug 25, 2015

Thanks @ssimpkin! While there's overlap with the wiki 'instructions for authors' page, I still think there's value to having it as a lesson - there'd be folks who want to write in Markdown who would never think of looking at our contribute page (and it's a great, simple overview).

Other editorial thoughts?

@miriamposner

This comment has been minimized.

Contributor

miriamposner commented Aug 25, 2015

Agreed!

On Tue, Aug 25, 2015 at 11:26 AM, Ian Milligan notifications@github.com
wrote:

Thanks @ssimpkin https://github.com/ssimpkin! While there's overlap
with the wiki 'instructions for authors' page, I still think there's value
to having it as a lesson - there'd be folks who want to write in Markdown
who would never think of looking at our contribute page (and it's a great,
simple overview).

Other editorial thoughts?


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

@fredgibbs

This comment has been minimized.

Contributor

fredgibbs commented Sep 1, 2015

me too--i think the authors page is about our process and doesn't offer
much in the way of markdown, which we require. so it's super helpful.

a possible addition to the lesson would be a concluding paragraph or so
about the process of writing a markdown file (like a PH lesson) in a basic
text editor, knowing that all the formatting will show up eventually, and
that getting used to the idea of not actually seeing the formatting--but
rather the syntax for it--takes a little time but is super useful. this
makes the files highly portable (not just over time, but across different
platforms and editorial workflows!).

the one other addition i would like, but isn't necessarily essential, is to
have more consistent visualization of the rendering of markdown in the
tutorial itself so that users can skim through the lesson and easily see
what markdown produces when rendered or converted into something else like
HTML. it appears in some places, but not in a standardized way or evenly
across the examples. i think smoothing this out would make the lesson more
useful for those just skimming through to understand what markdown is, and
also even more useful for readers who sit down and go through the whole
thing and want to easily associate the syntax with a typographical style
they are used to. obviously the markdown renderer does this, but i think
there's real value in having it in the lesson itself as well. (the renderer
could be used for other things in the lesson, too, like instructing the
reader to take a raw .md file from the PH repository and paste it into the
renderer to see what happens...)

but it's going to be really great to have this on the lesson page!

On Tue, Aug 25, 2015 at 10:20 AM, Miriam Posner notifications@github.com
wrote:

Agreed!

On Tue, Aug 25, 2015 at 11:26 AM, Ian Milligan notifications@github.com
wrote:

Thanks @ssimpkin https://github.com/ssimpkin! While there's overlap
with the wiki 'instructions for authors' page, I still think there's
value
to having it as a lesson - there'd be folks who want to write in Markdown
who would never think of looking at our contribute page (and it's a
great,
simple overview).

Other editorial thoughts?


Reply to this email directly or view it on GitHub
<
#61 (comment)

.


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

frederick w gibbs | assistant professor of history | univ. of new mexico
fredgibbs.net | @fredgibbs
http://www.twitter.com/fredgibbs

@wcaleb

This comment has been minimized.

Contributor

wcaleb commented Nov 9, 2015

This lesson seems to me like it's ready to merge. Unless I'm mistaken, I think it's already been reviewed, and revisions have been made. It all looks good to me!

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Nov 9, 2015

Ah, I missed the little commit hidden there. I think it looks ready to go! What do you think, @ssimpkin?

@ssimpkin

This comment has been minimized.

Contributor

ssimpkin commented Nov 9, 2015

Sending it off to another colleague for a quick look, then it's just a
matter of adding the reviewers' names. Will wrap it up by the end of the
week. Excited to get it out there!

On 9 November 2015 at 08:43, Ian Milligan notifications@github.com wrote:

Ah, I missed the little commit hidden there. I think it looks ready to go!
What do you think, @ssimpkin https://github.com/ssimpkin?


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

ianmilligan1 added a commit that referenced this pull request Nov 24, 2015

Merge pull request #61 from ssimpkin/gh-pages
I think we're good to go on this front! I've added @ssimpkin's Getting Started with Markdown lesson. It should be good to go on the lessons page! @ahegel @acrymble

@ianmilligan1 ianmilligan1 merged commit 291e89e into programminghistorian:gh-pages Nov 24, 2015

@acrymble

This comment has been minimized.

Contributor

acrymble commented Dec 2, 2015

@ianmilligan1 I don't think anyone is posting this. Can you manage it?

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Dec 2, 2015

Where do we find our images (i.e. do we have a central repository of our images, or do we just randomly find them on the Web and make sure we've got the rights)? I'm at a conference all week but can probably find some time.

@acrymble

This comment has been minimized.

Contributor

acrymble commented Dec 2, 2015

Instructions here: https://github.com/programminghistorian/jekyll/wiki/Lesson-Images

But I can't figure out how to actually upload the image to the site. If you figure that out, let me know.

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Dec 2, 2015

Sure, I can do that - wanna just shoot me it via e-mail? if you give me a good shortcut to downsize an image to 200 x 200 - any online platform that you use? My Photoshop is borked.

(am at a conference so there's a chance I might disappear until tomorrow at any point)

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Dec 2, 2015

Nevermind, just found the world's sketchiest photo resizer site and used it. If you shoot me the image, I'll upload them together.

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Dec 2, 2015

It also occurs to me - what section should this go into? Data Manipulation is the closest current fit, but it's not a great one. Any offhand thoughts, @acrymble?

@acrymble

This comment has been minimized.

Contributor

acrymble commented Dec 2, 2015

Data Management, no? But the title is awkward. It's about formats for best
practices.

On Wed, Dec 2, 2015 at 7:39 PM, Ian Milligan notifications@github.com
wrote:

It also occurs to me - what section should this go into? Data Manipulation
is the closest current fit, but it's not a great one. Any offhand thoughts,
@acrymble https://github.com/acrymble?


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

@acrymble

This comment has been minimized.

Contributor

acrymble commented Dec 2, 2015

Maybe we need a new category.

On Wed, Dec 2, 2015 at 7:41 PM, Adam Crymble adam.crymble@gmail.com wrote:

Data Management, no? But the title is awkward. It's about formats for best
practices.

On Wed, Dec 2, 2015 at 7:39 PM, Ian Milligan notifications@github.com
wrote:

It also occurs to me - what section should this go into? Data
Manipulation is the closest current fit, but it's not a great one. Any
offhand thoughts, @acrymble https://github.com/acrymble?


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

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Dec 2, 2015

I figure Data Management is OK for now, but we should think about a new category?

In any case, it's LIVE!!! Hurray. Both on http://programminghistorian.org/lessons/ and http://programminghistorian.org/lessons/getting-started-with-markdown.

Can we start the publicity engine? 😀

@ssimpkin

This comment has been minimized.

Contributor

ssimpkin commented Dec 2, 2015

Oh hey, awesome! Looks like it's under "Data Manipulation" instead of "Data
Management", though.

I'll send along a little bio blurb shortly.

Thanks again for all of your patience and suggestions. It was fun!

On 2 December 2015 at 18:21, Ian Milligan notifications@github.com wrote:

I figure Data Management is OK for now, but we should think about a new
category?

In any case, it's LIVE!!! Hurray. Both on
http://programminghistorian.org/lessons/ and
http://programminghistorian.org/lessons/getting-started-with-markdown.

Can we start the publicity engine? [image: 😀]


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

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Dec 2, 2015

Sorry @ssimpkin, fixed in the last commit. And yes, please send along a bio - probably easiest is to just e-mail it to me.

@ianmilligan1

This comment has been minimized.

Contributor

ianmilligan1 commented Dec 3, 2015

As per #119, pinging @miriamposner to let her know that this post is up. @acrymble's "Extracting Keywords" is up too. A banner day!

@miriamposner

This comment has been minimized.

Contributor

miriamposner commented Dec 8, 2015

Gah, somehow I didn't see this! I will tweet up a storm tomorrow. Congrats, @ssimpkin and @acrymble!

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