Guide to childlanglab

Update the guide

Purpose

Allow lab members to update the lab guide with new procedures and faqs.

Procedure

Prerequisites

1. Create a github account
2. Ask Katie on slack to add you to the pennchildlanglab organization on github
3. Do the markdown tutorial

Update an existing page

1. Login to github
2. Go to https://github.com/pennchildlanglab/guide
3. Click on the README.md file
4. Click on the relevant page you want to update
5. Click the pencil icon in the upper right corner of the page (the edit button)
6. Edit the markdown content
7. Please keep the format of the guide consistent
   • Title is H2, eg ## Update the guide
   • Three headings at H4: Purpose, Procedure, FAQs, e.g. #### Purpose
   • Use subheadings if necessary at H6, e.g. ###### Prerequisites
   • Use numbered lists in the Procedure section
   • Use bulleted lists for FAQs, and quotes (e.g. >) for answers
8. Click commit changes (green button in upper left) to publish your changes to the website

Adding a new page

1. Please don’t add a new page directly
2. Instead, create a bug/feature request on todoist
3. Describe the page you want to add and why, and include a draft of what you would include in the comments

FAQs

• How detailed should I be?

  Be clear, but consise. Nobody likes to read a super long instructions page. Keep it to a short, numbered list.

• I’m not confident making a change. What should I do?

  That’s fine. You can create a bug/feature request with your suggested changes and our lab manager can update the page for you

• Can I add pictueres or video?

  Yes, but only when truely necessary. Internet pages update often, so it doesn’t take long before pictures are obsolete. Processes usually remaining similar, even if it looks different. And text is quicker to update.

• I clicked “Commit changes” but I don’t see my changes on the website

  Try refreshing the page. But it can take a few mintues to update. If you don’t see it after refreshing and 5 minutes, add a bug/feature request.