computersciencehouse/blog

A public blog for CSH

CSH Blog

Installation

• Clone this repo
• Run bundle install to install dependencies
• Run bundle exec jekyll serve to generate and run site
• The blog is now running at http://127.0.0.1:4000/!

Dependencies

Debian/Ubuntu

apt install ruby-dev

Fedora/RedHat

dnf install ruby-devel zlib-devel

Posting

• Fork this repo
• Locally, and after installation, either:
  • Run ./newPost.sh and fill in metadata to automatically generate a new post file
    • Fill in the post content, and verify YAML Front Matter OR:
  • Make a new file in _posts/:
    • Title the file YYYY-MM-DD-your-title-here.md (i.e. 2017-10-23-hello-world.md)
    • Fill in the YAML Front Matter at the top of the file, as detailed below
    • Below the Front Matter, write the body of the post, in Markdown
• Push the new file(s) to your fork, and make a Pull Request to this repo

Post Format

---
layout: post
title: ""
date: 
categories:
  - 
description: 
image: 
image-sm:
author: 
author-image: 
author-bio: 
author-email: 
author-social:
  github: 
---

Example

---
layout: post
title:  Intro to GitHub
date:   2017-10-22 12:25:00
categories: 
  - git
  - GitHub
description: GitHub is an incredible tool, not only for development, but for learning
image: https://devinmatte.github.io/images/posts/intro-to-github/profile.png
image-sm: https://devinmatte.github.io/images/posts/intro-to-github/profile.png
author: Devin Matte
author-image: https://avatars3.githubusercontent.com/u/9310513
author-bio: Second Year Software Engineering Student at Rochester Institute of Technology
author-email: [email protected]
author-social:
  github: https://github.com/devinmatte
  linkedin: https://www.linkedin.com/in/devin-m-5556a386/
---

blog's Issues

Dependencies beyond ruby dependencies

bundle install is a neat first step - assuming your system has bundle installed at all. Maybe a gem install bundler instruction - You'll also need the -dev or -devel packages (depending on distro) of several things (including ruby, zlibc, etc.) to really install everything you need.

I get that specifying packages for every possible distro is a infeasible request, but maybe some mention of it would be cool.

newPost.sh cant handle punctuation in titles - I assume

$ sh newPost.sh
Title: CSH Done: How to sort of complete projects, maybe
Date [2017-11-23]:
Categories (space-separated): projects
Description: Done and CSH-Done are two very different things, as I've come to learn
Post Image URL (full size): https://csh.rit.edu/~zach/photos/hallway.jpg
Post Image URL (smaller): https://csh.rit.edu/~zach/photos/hallway.jpg
Author Name: Zach Hart
Author Image URL: https://csh.rit.edu/~zach/photos/avi.jpg
Author Bio: Whatever year computer science student at the Rochester Institute of Technology. Likes long evenings crying alone while watching Scott Pilgrim vs. The World and having existential crises.
Author E-Mail: [email protected]
Author GitHub URL: https://github.com/zthart
Author LinkedIn URL: https://linkedin.com/in/zthart
newPost.sh: 23: newPost.sh: function: not found
newPost.sh: 25: newPost.sh: Syntax error: "}" unexpected

I'm no computer, but my best guess here is that non-alpha characters don't make this script particularly happy.

Default Photo in Archives

There should be something other than a black box on posts that don't include images. Whether it's the same default photo as on the post page, or something else, it shouldn't just be black

Add css for Tables

Currently there is no css for tables in blog posts. So If a table makes sense for a post it looks pretty bad.

It should be really easy to find some simple table css that makes sense for posts.

Implement a CI to block merging on Posts that fail

We have the linter check and make sure all links properly resolve, but that only get checked in the Jenkins pipeline on Openshift.
It would be nice if we could check using a CI to avoid merging in PRs that break the pipeline.

Photo flashes when mousing over blog entry blerb

When mousing over the blog entry blerbs on the right of the landing page, the image on the left hand side flashes. Observed using OSX 10.12.6 and Chrome Version 59.0.3071.115 (Official Build) (64-bit).

Fix Fonts

Currently the fonts that this template uses. although okay looking, don't fit the theme of CSH services and sites.

Update the fonts to be more uniform with the CSH public site/our logo

Most Recent Blog Post Rendering in Plaintext

The most recent blogpost has no title, and is rendered in plaintext when opened

Create a Script for Generating new Blog Posts

Since there's a bit of details needed in the yaml formatting at the top, we should make a script to prompt the user for everything they need and generate the properly formatted .md file for them to work with.

This would be a great Hackathon issue for someone to deal with

Set up Google Analytics

It'd be nice to know how many people are actually reading the blog, and what our reach is like. This would probably need some RTP help.

Swiftfall and FreeIPA are in Archives

In private browsing they are still there.

Separate author from post

I think it'd be better to have the author information defined in a separate file and have the posts simply reference an author by a key, such as the first and last name.

That way, if you need to update information about an author, such as changing their image or bio, you update those fields in that authors file, rather than having to go through every post they created and changing the values within those.

Add Default Background Image

It would be nice to get a photo of floor for the background. Something that's framed like the Insights Page would probably work out well.