Skip to content

Commit

Permalink
guides: 0-based numbering
Browse files Browse the repository at this point in the history
  • Loading branch information
edunham committed Oct 3, 2013
1 parent 053dd95 commit 5429d54
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
16 changes: 8 additions & 8 deletions content/blog/20130112_metaguide.mkd
Expand Up @@ -5,16 +5,16 @@ author: "Emily Dunham <dunhame@onid.oregonstate.edu>"
date: 2013-01-12
---

1) **Identify a topic** about which we need a guide. If you have an idea, great! If you're looking for something to write about, check out the [open issues][issues] about Guides. Ask around in the IRC channel and at meetings about what people would like to see guides on, as well.
0) **Identify a topic** about which we need a guide. If you have an idea, great! If you're looking for something to write about, check out the [open issues][issues] about Guides. Ask around in the IRC channel and at meetings about what people would like to see guides on, as well.

* Remember that you don't have to start out as an expert on a topic in order to create a great guide. In fact, someone new to a subject is at an advantage when writing an introduction for other newbies, because experts often leave out information that seems obvious based on their years of experience.

* To learn more about best practices and other areas that require expertise with your subject, interview an expert! They're usually happy to share, especially to help make a guide from which many people will benefit, and they'll thank you for taking the time to write up and publish their advice.

2) Make sure that your idea has a ticket open and assigned to you in the [guides category][issues] on our GitHub issue tracker. This will allow others to give feedback on your idea and what information they'd like to see in your guide, and it's good practice for professional software development workflows.
1) Make sure that your idea has a ticket open and assigned to you in the [guides category][issues] on our GitHub issue tracker. This will allow others to give feedback on your idea and what information they'd like to see in your guide, and it's good practice for professional software development workflows.
* If you're unable to create issues or assign an issue to yourself, make sure you're a member of the LUG organization. To become a member on GitHub, contact [an admin][ghlist].

3) **Outline the topic** of your guide. [Etherpad][etherpad] is a great place to draft your ideas and share them with others. You can create a custom URL for your etherpad by navigating to etherpad.osuosl.org/your-guide-topic-idea, substituting your topic for the placeholder text. If a pad by that name doesn't exist yet, you'll get the option of creating it.
2) **Outline the topic** of your guide. [Etherpad][etherpad] is a great place to draft your ideas and share them with others. You can create a custom URL for your etherpad by navigating to etherpad.osuosl.org/your-guide-topic-idea, substituting your topic for the placeholder text. If a pad by that name doesn't exist yet, you'll get the option of creating it.

#### Your guide should include:

Expand All @@ -30,17 +30,17 @@ date: 2013-01-12

* Summary or checklist of the most important steps

4) **Get feedback** on your outline. If you're new to the topic, check with an expert to see whether there are any holes or inaccuracies in the planned article. If you're an expert, have someone less familiar with the topic read through your outline to be sure you don't leave any major questions unanswered for the people that your writeup is supposed to be guiding.
3) **Get feedback** on your outline. If you're new to the topic, check with an expert to see whether there are any holes or inaccuracies in the planned article. If you're an expert, have someone less familiar with the topic read through your outline to be sure you don't leave any major questions unanswered for the people that your writeup is supposed to be guiding.

5) **Complete the content** of your guide. Try to keep it clear and concise. When you think you're finished, read it out loud to your roommate, laptop, or cat. Fix the parts that sound funny, because if it doesn't sound good to you, it'll be just as bad for everyone else who tries to read it.
4) **Complete the content** of your guide. Try to keep it clear and concise. When you think you're finished, read it out loud to your roommate, laptop, or cat. Fix the parts that sound funny, because if it doesn't sound good to you, it'll be just as bad for everyone else who tries to read it.

6) **Make it pretty**. Most LUG guides are formatted using [Markdown][mkd], which is an easy markup language to learn. Look at the source of the [other guides][guides]and compare it to how they show up on the website, to get a feel for how Markdown syntax works. And, for the love of grammar, PROOFREAD IT! If you're not sure you've caught all the errors, or just want some feedback, drop a link to your draft in the IRC channel and we'll help you out.
5) **Make it pretty**. Most LUG guides are formatted using [Markdown][mkd], which is an easy markup language to learn. Look at the source of the [other guides][guides]and compare it to how they show up on the website, to get a feel for how Markdown syntax works. And, for the love of grammar, PROOFREAD IT! If you're not sure you've caught all the errors, or just want some feedback, drop a link to your draft in the IRC channel and we'll help you out.

7) **Get it online!** Clone or fork the [website repository][site] on Github, add your guide to the [content section][guides], then submit your changes for approval via patch or pull request. If you'd like help, any [LUG officer][officers] or [LUG github admin][ghlist] can walk you through the process or help you find resources to answer your questions.
6) **Get it online!** Clone or fork the [website repository][site] on Github, add your guide to the [content section][guides], then submit your changes for approval via patch or pull request. If you'd like help, any [LUG officer][officers] or [LUG github admin][ghlist] can walk you through the process or help you find resources to answer your questions.

* You can create a new file without leaving the Github web page using the + icon which appears after "OSULUG-Website / content / " in [the source][guides].

8) Congratulations, **you're done!** Double-check that your guide appears correctly on the LUG website, and brag about your successful writing career to all your friends.
7) Congratulations, **you're done!** Double-check that your guide appears correctly on the LUG website, and brag about your successful writing career to all your friends.

[issues]:https://github.com/OSULUG/OSULUG-Website/issues?labels=Guides&state=open
[ghlist]:https://github.com/OSULUG?tab=members
Expand Down
6 changes: 3 additions & 3 deletions content/blog/20131003_organizing_installfest.mkd
Expand Up @@ -5,15 +5,15 @@ author: "Emily Dunham <dunhame@onid.oregonstate.edu>"
date: 2013-10-03
---

1) **Before Term Starts**
0) **Before Term Starts**

Pick a time and date for the InstallFest. The usual LUG time (Tuesday at
6pm) generally works, and we usually have a room for it as well. Contact Tina
Batten from EECS to reserve KEC1005 or KEC1007. Week 2 or 3 is generally a
good time to have InstallFest, since students in the introductory CS classes
have realized they need Linux but haven't gotten it yet.

2) **During Week 1**
1) **During Week 1**

Make a list of which classes the LUG should present about InstallFest in.
Depending on the term, the table you'll fill out might look something like:
Expand Down Expand Up @@ -67,7 +67,7 @@ them. Make sure that there are actually LUG students available to visit each
class we ask to visit. If nobody is available to visit, ask to just send a
message to the class lists instead.

3) **Send Emails.** This is easiest if one person (probably president, VP, or
2) **Send Emails.** This is easiest if one person (probably president, VP, or
secretary) handles all the scheduling. This person should send the messages
from their ONID or ENGR address, since some professors filter out messages
from gmail and other non-student accounts.
Expand Down

0 comments on commit 5429d54

Please sign in to comment.