Git Product home page Git Product logo

fossrit / people Goto Github PK

View Code? Open in Web Editor NEW
9.0 14.0 34.0 254 KB

Interactive directory of FOSS@RIT community members generated from YAML profiles and built with Jekyll

Home Page: https://fossrit.github.io/people/

License: GNU General Public License v3.0

HTML 57.74% Shell 20.72% Ruby 17.33% SCSS 4.21%
yaml-files html student-profile university rit rit-community rochester-institute-of-technology rochester students jekyll

people's Introduction

people

License: GPL v3 Build Status

Interactive directory of FOSS@RIT community members generated from YAML profiles and built with Jekyll

About

The People project FOSS@MAGIC faculty and staff maintain a current roster of:

  • Alums
  • Faculty
  • Mentors
  • Students

The profiles are used for record-keeping and contact information.

Installation

People uses a Ruby-based static site generator called Jekyll.

  1. Install a full Ruby development environment.

  2. Install bundler and this project's Gemfile.

    gem install bundler
    bundle install
  3. Build the site and make it available on a local server.

    bundle exec jekyll serve --watch
  4. Browse to http://localhost:4000

Ta-da, the project should appear locally in your browser.

Usage

bundle exec jekyll serve --watch

Contributing

Want to contribute a profile? See our contributing guidelines.

If you want to help with the actual project, awesome! First, check the open issues for things we are working on or need help with. Please open an issue to discuss changes before submitting a pull request.

Need help?

Join #rit-foss on the Freenode IRC network or join the bridged Telegram group.

Legal

All work licensed under GPLv3.

people's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

people's Issues

Use pipenv

Once Travis adds support for pipenv, or pip learns pipfile support, switch to using it

Research planning for foss-profiles v2.0

Summary

Determine a new way to automatically deploy foss-profiles HTML into a hosting site

Background

This is a new project in 2020 for the @FOSSRIT/tech-team. foss-profiles is one of the oldest projects we have, and it acts like a directory of folks involved with the FOSS community at RIT. To bring it one step further, we want to generate and publish the HTML pages each time a new pull request is merged.

The requirements for v2.0 are as follows:

  • Use YAML files to build and generate profiles for each type of person (alum, faculty, mentor, student)
  • When new PRs are merged into master, automatically generate HTML and publish it on a publicly visible URL
  • Easy way to test changes locally before making a new PR (e.g. build/generate HTML locally)

Details

@10eMyrT and I met at BrickHack 6 and outlined what the interface could look like, some of the tools for the job:

Whiteboard diagram of possible user interface and some tools we could use

We discussed two possible ways of doing this. The decision we make could be a mix of these too, or an idea we haven't considered yet. The emphasis should be on reducing cost and easy maintainability:

  • Apache OpenWhisk
    • Use a cloud platform for hosting serverless OpenWhisk + code
    • Use GitHub webhooks to trigger new builds from commits on master
    • Need somewhere to publish generated HTML
  • Jekyll + GH Pages
    • Jekyll is a common Ruby framework
    • Code hosted in GitHub repo
    • HTML automatically-generated from source, built and published on new commits to master
  • docsify
    • Another tool suggested to us by someone listening in at BrickHack, but I haven't looked into it yet

Outcome

Anyone can view the foss-profiles directory on the web

[story] Add icons / logos for different git forges / social profiles

Summary

Add icons / logos for git forges and social profiles instead of using text

Background

Currently when someone adds a git forge or a social media to their profile, it appears as a text link beneath their profile, e.g. a GitHub profile appears as GitHub below their profile. Instead of using text, it would be more visual and user-friendly to use an icon or logo from the git forge, e.g. :octocat: for a GitHub profile.

Details

@kennedy had looked into this for #69 but it was a little tricky to do. If possible, SVGs should be the preferred format for the logo, but a hi-res PNG is also acceptable.

Outcome

More visual and user-friendly appearance for common git forges / social media profiles

[story] Sort profiles in each category in alphabetical order

Summary

Sort profiles in each category (e.g. Student, Alum, Faculty, Mentor) in alphabetical order

Background

To make profiles easier to navigate and sort, it would help to list them in alphabetical order by the names provided for each profile. It's a small quality-of-life improvement that makes it easier to browse through the profiles in each category.

Details

@kennedy noted this is tricky because of how each profile is stored internally in Jekyll. This story needs additional research.

Outcome

Easier to sort and browse through profiles, especially as the list grows longer

Missing README

@msoucy we need to add a README with instructions on how this repo works, and how to generate templates.

So far, so good though 😄

[story] Support profile pictures / icons in profiles

Summary

Add support for profiles pictures / icons in user profiles

Background

It be a friendly touch to add profile pictures or icons for people with profiles on the site. This helps give faces to the people behind FOSSRIT and makes the site a little more visual.

Details

We discussed Gravatar, but @kennedy originally looked into this and discovered issues with doing this in Jekyll. It would be cool to use Gravatar but may not be practical.

One alternative is that since we already inquire for git forges, maybe we could pull profile pictures from the image someone already uses on a site like GitHub or GitLab.

Outcome

  • More visual, friendly touch to FOSS-profiles site
  • Easier to map nicknames / handles to actual faces

Create fossrit.community subdomain for foss-profiles

Summary

Create a subdomain on fossrit.community for the new foss-profiles GitHub Pages site

Background

Over in #69, @kennedy casually whipped together a new Jekyll site that turns our nifty collection of YAML profiles of folks at RIT into an actual web app. Once his PR is merged and the site is published, it would be nice to give it a subdomain to make its web presence a little more official.

If a sub-domain is not assigned, I'm pretty sure it will default to fossrit.github.io/foss-profiles/. Which works, but it is a little wieldy.

Also, the intended audience for this web app is internal to RIT, i.e. people who are already involved and active with the FOSS@RIT community. Currently I don't expect us to bring this to conferences or link it all around the web. It's mostly a reference for people who are at RIT to see who folks doing open source at RIT are and a little bit on what they are doing.

Details

I wanted to open this up for community input on what the subdomain is. I don't want to spend too much time focusing on a very narrow detail, but once we commit to a subdomain, it's important we stick with it for the benefit of long-term persistence.

Here's the options I was thinking of:

  • whois.fossrit.community
  • directory.fossrit.community
  • dir.fossrit.community

I'm particular to whois.fossrit.community but open to suggestions.

Outcome

Dedicated web presence for new foss-profiles website that we can share around with folks at RIT, and possibly round up more profiles for people we are just starting to meet doing open source at RIT

[story] Integrate more closely with FOSS@RIT website

Summary

Tie web presence for FOSS-profiles more closely with FOSS@RIT website

Background

The FOSS-profiles website should be loosely connected to the FOSS@RIT website. The FOSS@RIT website links to this website in the navigation bar. The FOSS-profiles website has a button to take you "back" to the FOSS@RIT website.

The purpose of doing this is keeping our web presence united and together. Instead of sprawling out in isolated areas, this boosts the overall discoverability / visibility of the FOSS-profiles site by connecting it to the main FOSS@RIT website.

Details

  • Add link in header "Back to FOSS@RIT website"
  • Copy footer styling from FOSS@RIT website (?)
  • Add link to FOSS@RIT website nav bar to FOSS-profiles website

Outcome

Easier to discover and find FOSS-profiles site

Rename repo to "community"

Between #71 and #72, we may or may not assign a DNS subdomain to this repo. If we turn down #71, I suggest renaming this repository to community so the published URL becomes fossrit.github.io/community. I think this is more memorable and user-friendly, and also loosely supports the overall goal of #72 in integrating the web presence of the two Jekyll sites.

[story] Add interactive search bar

Summary

Add a search bar to search through existing profiles

Background

A search bar would be a nice touch to sort through the profiles that exist on the site. Not only would it include name, but it might also include things like major or graduation year. It would make the site easier to navigate as more and more profiles are added over time.

Details

This is probably very hard and might not be possible within Jekyll. That said, we wanted to put this out there as an open-ended research question to explore what future options might be to implement this.

Currently it is not a high-priority story, but it is a "nice to have" task.

Outcome

Easy to sort and filter through profiles as more are added

[story] Automatically move graduated students to alums

Summary

Move an existing student profile to an alum profile once their graduation year passes

Background

One of the most tedious parts of maintaining this repo is following up when a student has moved on and graduated from RIT. Currently this is a manual task and requires looking at existing student profiles and moving them over to alums once they graduate. It would lower the burden of maintenance to automatically move students to alums once the provided graduation year passes.

Detail

This might not be possible within the scope of using Jekyll. That said, since we do collect graduation year as metadata in profiles, it would be an interesting research question to explore for future development.

Currently this is a low priority story. It is a "nice to have" but we shouldn't spend too much time trying to get this work.

Outcome

Easier to maintain site and keep profile statuses current

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.