Skip to content

Latest commit

 

History

History
104 lines (52 loc) · 5.18 KB

README.md

File metadata and controls

104 lines (52 loc) · 5.18 KB

Instructions for setting up GitHub organizations and team websites

Set up GitHub

Create a GitHub Organization for your team

One student from each team will create and set up the team organization following the steps below:

  1. Create a new organization using the instructions in the link: https://help.github.com/enterprise/2.8/user/articles/creating-a-new-organization-from-scratch/

Please name the team as rss2018-team[team number], e.g., rss2018-team1.

  1. Add all your team members to the Owners team using their GitHub username which will give them read and write access to all repositories in this organization.

  2. Add Samir Wadhwania ([email protected]) as an owner of the organization as well.

For all future labs, you will be creating repositories (e.g. lab_3) within this organization. Because the entire team is part of the organization, everyone will be able to push and pull to the repo.

Hint: Have one person create the repo, and have everyone else clone the repo at the start of new labs

Fork the website_template repo to your organization

The GitHub organization must be created before this step.

  1. Navigate to the TA website_template repo found here: https://github.mit.edu/2018-RSS/website_template

  2. Click the Fork button in the top-right corner. When it asks where to fork the repo to, pick your newly created organization.

  3. In the settings of the repo, rename the repo to:

    rss2018-team[team number].github.mit.edu

Make the repo a GitHub Page

GitHub allows you to create a website from a repository. We will be using this repo as the team website repo where all future lab reports will be submitted.

In the settings, scroll down to the GitHub Pages category. In the Source Category, choose master branch. This tells GitHub to look for the index.html file in the master branch from which to create the website.

Set up the website

Set your team name and number within the website

We do not expect you to know how to build a website or use HTML/CSS. However, editing the given files to you should be quick and easy.

Read through the index.html file to see how the website is structured. Wherever you encounter [Insert Team Name here] or [Insert Team # here], do just that.

The team name is up to you to decide!

Create your About page

If you look at the files given to you, you will discover the about.md file: assets/posts/about.md. This file is used for the About page.

The current About page is an example from a previous year's team. Replace the members' information with your own team's information, and don't forget to include pictures! Pictures can theoretically be stored anywhere, but it's good practice to organize your files neatly. Pictures for the About page are currently in assets/pictures/about/.

Note: It is encouraged to do this without using any HTML!

Link to your GitHub

In the index.html file, find the line that reads:

<a href="https://github.mit.edu/" target="_blank">GitHub</a>

Fill in the URL to your team's organization so that the website will link to your GitHub and, subsequently, labs.

Remove the Setup button

In the index.html file, find the line that reads:

<li><a href="#instructions">Setup</a></li>

Comment it out using:

<!-- <li><a href="#instructions">Setup</a></li> -->

Notes for the future

Creating lab reports

You will see that there is a template for a lab report titled lab3.md. As you can see, the post is written using Markdown. If you've never used Markdown before, you can find a cheatsheet here:

https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code.

Also, LaTex is supported! Many of the reports will require you to display equations: delineate LaTex equations by wrapping them with $$ (e.g. $$\frac{1}{2}$$) and they will be converted to LaTex when the website loads.

Note: This will work best when the LaTex equations are on their own lines.

There are plenty of tools to work in Markdown. For future labs, create your lab reports using markdown, and save them as lab[#].md within the posts folder, and the HTML will automatically be created for your website.

Feel free to use plenty of pictures, gifs, and videos in your lab reports! No one likes reading blocks and blocks of text.

Linking the lab presentations

In the index.html file, there are links to lab presentations that are unfinished. As you create lab presentations, make sure to link to them on your website.

Video

Eventually, you will create a final video for the class. This is what the video button will eventually link to.

If you'd like, you can link to a YouTube channel where you can post multiple videos of the car! We only expect to have the final video linked.

A note on pictures

Make sure that the pictures you use are relatively lightweight. It's not uncommon to use PNG for most images on websites so that they load faster.