Open Source Club website

This Jekyll site is a fork of the Minimal Mistakes Jekyll Theme.

This means that all that is needed to add a talk or a news item in a weekly rundown is to issue a PR with the new item under the _posts or _tutorials directory respectively.

Updates

The intro: - title: in index.html file should be kept up to date with the latest info. For instance, while setting this up in summer, it does nobody any good to have it display information about meetings during the school semester. Therefore, I am making sure that it says we'll be back for our the Fall 2017 semester.

Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your personal site, blog, or portfolio on GitHub or self-hosting on your own server. As the name implies --- styling is purposely minimalistic to be enhanced and customized by you 😄.

For detailed instructions on how to configure, customize, add content, and more read the theme's documentation.

Quick Start

Docker Deploy

Run the following three commands in the project's root directory:

docker-compose up --build [-d]

The application will now be accessible on localhost:8000 with any supported web browser. If the -d flag was passed, the container will run in the background. If there is a change to anything, the docker instance must be stopped (CTRL-C if not daemonized, otherwise docker-compose stop) and the command re-run. This imports the new files into the container and re-runs it with the new content.

NOTE: This is less than ideal, however, for the time being, since the directory needs to be cleaned before it is regenerated, and that's not able to be done in the Rakefile without causing an infinite loop, it's easier to just regenerate the image layer. Also, since the volumes wouldn't be mounted before it generated, it wouldn't generate in the first place. I'd love to find a way around this eventually.

If you want to find out how to run the program in your base OS, take a look at the Dockerfile and follow the steps as appropriate.

Build Website on `stallman2`

Club members should be able to build the site, as all required software is installed globally to build it. HOWEVER not all club members will have the appropriate permissions to deploy the site. If you are not an officer and wish to make a change to the site, please follow the Git Workflow, and submit a pull request on Github for the change to the site.

For Officers

To build the site from master:

### YOU SHOULD ALREADY HAVE THIS
### THIS IS USING SSH KEYS - WHICH YOU SHOULD HAVE ALREADY SET UP
$ git clone git@github.com:OSUOSC/website.git
$ cd website
$ bundle exec rake gen_site
$ ssh web3
$ sudo rsync -av --delete ./website/_site /var/www/jekyll/
$ sudo chown -R www-data:www-data /var/www/jekyll

New Content

Creating a new post

Every week, a new post is created for the news items to be gone over at the beginning of the meeting on Thursday. This is automatically generated in the same way that the site is generated and cleaned, by using bundle:

$ bundle exec rake new_post

The new post is created in the _posts directory, under the format YYYY-MM-DD-meeting.md, the date being the date of the next meeting (AKA the next Thursday). If you try to run it twice, it will throw an error containing the file that it detected to be the one it was supposed to create.

After that, the page can be edited and content added. The content is broken up into stories for us to go through one at a time at the beginning of the meeting. The format for the file is as follows:

title:
- The title of the story.
link: (optional)
- The link to the article, video, or whatever that contains the meat of the content.
image (optional)
- The image that is displayed (at an automatically adjusted size) in the page that we'll be going over during the meeting. This accepts a URL that is compiled in at the time that the site is generated.
notes (optional)
- This should be the meat of the content that is put in the file. These are the notes (typically bullet points) that are ran through when announcing the story to the club. As long as there is a pipe (|) after the notes keyword, all following lines (before the next story item) will be 'markdownified' - aka formatted from markdown into HTML at the time that the site is generated.
- NOTE: The markdown must be indented correctly in order to be properly rendered.

Example:

- title: "Android Studio 2.0 Released"
  link: "http://android-developers.blogspot.com/2016/04/android-studio-2-0.html"
  image: "https://1.bp.blogspot.com/-vxXg6Inv_WA/VwaJ0uzSf_I/AAAAAAAACr4/xzszbcRzWRgSaHXpOpYroG7u6bgsFJjqw/s200/image03.png"
  notes: |
    > Instant Run: Changes to a running app appear live.

    * Faster Android emulator and adb.
        * Cloud Test Lab: Test apps on a wide range of physical devices easily.
        * bullet points
            * as far as
                * you could want

    [links work also](https://opensource.osu.edu)

    ## This is a header

    ### This is another header

    ```
    lorem ipsum code
    ```

NOTE

Since running bundle exec rake new_post does require bundle to be installed, it is presumed that the file would be created on stallman2 or by another admin earlier in the week, so the impetus is not on the contributors to do so.

TODO: There should be better ways to create a new:

Event
News
Tutorial
Info

Adding new pages

If you go to add new pages to _pages the default header info should be:

---
layout: archive
title: <title of page>
permalink: /<link name>/
---

And make sure that the permalink ends with a slash so that it's generated in the same form as the rest of the site.

Contributing

Having trouble working with the site? Found a typo in the documentation? Interested in adding a feature or fixing a bug? Then by all means submit an issue or pull request. If this is your first pull request, it may be helpful to read up on the GitHub Flow first.

Pull Requests

When submitting a pull request:

Clone the repo.
Create a branch off of master and give it a meaningful name (e.g. my-awesome-new-post) and describe the feature or fix.
Open a pull request on GitHub.

Development

To set up your environment to develop this theme, run bundle install --path ${HOME}/.gem.

NOTE: If you're already on `stallman2`, these should already be installed system-wide

Updating the theme will require a rebase. There is a branch to do this, however, the upgrade process is undocumented. For those looking to update the theme, first take a look at the history of the commits (git log) and try to merge upstream with the fork. There will most likely be a conflict of history when you go to merge onto master, but that might be taken care of with the argument --allow-unrelated-histories. USE THIS OPTION WITH CAUTION.

Consult an officer before attempting to git rebase.

Credits

Creator

Michael Rose

OSUOSC customizations

AndrewCz

Icons + Plugins:

The Noun Project -- Garrett Knoll, Arthur Shlain, and tracy tam
Font Awesome
Unsplash
Multipage

Other:

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dominikWin/website