Skip to content

bradleybrecher/bugs-nyu.github.io

 
 

Repository files navigation


How to Contribute

What to Contribute

How to use Jekyll


How to Contribute

For adding markdown Events

  1. Fork this repository
  2. Make a new markdown (filename ending with .md) document in the "_events" folder of your fork
  3. Follow the template event by including this at the top with the correct information:
---
layout: event
title: "Your Event Title"
event_date: 2017-12-31
time: "Event Time"
location: "Event Location"
---
  1. Then include the entire event description in markdown using this guide for help
  2. Make a pull request to the original repository

For adding markdown News posts

  1. Fork this repository
  2. Make a new markdown (filename ending with .md) document in the "_posts" folder of your fork
  3. Follow the template post by including this at the top with the correct information:
---
layout: post
title: "Your Post Title"
date: 2017-12-31
---
  1. Then include the entire news post description in markdown using this guide for help
  2. Make a pull request to the original repository

For larger Contributions

  1. Fork this repository
  2. Make your fork live through your GitHub Pages domain
  • If you don't already have GitHub Pages, set it up by following this guide
  • In your forked repository, go into the Settings > to the GitHub Pages section > and change Source from "None" to "master branch" like so: contribute1
  • Go to the file "_config.yml" contribute2 and change baseurl and url to your GitHub Pages settings like so: contribute3
  1. Make any changes you want
  2. When you are ready to make a pull request, you should make a new branch and revert the "_config.yml" file to its original form in this new branch
  3. Make a pull request from your new branch, while keeping your master branch live on your GitHub Pages for reviewers to study before merging your pull request. In your pull request description, please include a link to the live master branch on your GitHub Pages

What to Contribute

Ongoing Needs

  • Make markdown files for upcoming BUGS events, including:
    • General club meetings
    • Small group project meetings
  • Make markdown files for news stories related to open source, including:
    • General news about BUGS
    • Interesting open source projects outside of BUGS
    • Interesting tech news related to open source
    • Etc

Planned Features

  • Display all student contributors
  • Add more project details
    • Display To Do's
    • Display student contributors
    • IRC/Discord
  • Add IRC Client
    • Link to Discord
    • Info on how to setup your own client

How to use Jekyll

Installing Jekyll

GNU/Linux and MacOS

If you're running GNU/Linux or MacOS on your system check if you have Ruby version 2.2.5 or above and RubyGems installed on your system.

Ruby - https://www.ruby-lang.org/en/downloads/

RubyGems - https://rubygems.org/pages/download

Run gem install jekyll once you have RubyGems installed on your system to install Jekyll.

Windows

If you're running windows take a look at this guide: https://jekyllrb.com/docs/windows/#installation

Using Jekyll

To start a development server run jekyll serve in the project source folder. The the server will run at http://localhost:4000

Resources for Jekyll syntax and usage:

About

The website for the BUGS organization hosted through Github Pages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 59.2%
  • HTML 39.8%
  • JavaScript 1.0%