Git Product home page Git Product logo

rse-escience-2022-vsoch-template's Introduction

Research Software Engineer Community Template

This is a community template for a research software engineer group. It is provided for you to copy to your GitHub organization to then have a portal for your center.

How does it work?

The site offers the following features:

  • A site wide search, and "Find an RSE" search to help users find support they need.
  • An optional Twitter feed if your group shares an alias.
  • Individual pages for your site members. Each individual can share a biography and areas of expertise to better offer support to users.

Creating your Community

You can create your repository from the template here.

1. About your Group

You can modify the about.md file to add information about your center. This will show up on the Community -> About tab.

2. Support Your Offer

In the support.md you should describe the support that your group offers. This will be searched by users to find help, so be sure to include details about the resources and services that your group offers.

3. Add People

Any interested RSE at your institution can a page to the _people collections folder. The header of the file should include links, social media, and descriptors;

---
name: Antonio T. Rex
title: Research Software Engineer
url: https://douglascuddletoy.com/shop/fantasy-whimsy/t-rex-s-dinosaur-w-sound/
image: rex.jpg
github: rseng
twitter: dinosaur
---

And they are free to write whatever they please in the content area! Images should be relative paths specified above, and expected to be in assets/img/people. A biography and description of expertise is usually appropriate, as the content will be searchable for users to find support for areas of interest.

4. Write Posts

If you want to use your community space to write articles or post news, you can do so by adding a new markdown file to the _posts folder. We've left a few entries there for you as examples. If you want to add your community site to any feed syndication that supports xml, there is a feed of posts exposed at https://localhost:4000/community-template/feed.xml.

5. Social Media

If your group has a Twitter alias, define the twitter variable in the _config.yml file to show a feed of posts on the right side of the main page. By default this is disabled, and individual engineers are able to define their own Twitter aliases in their personal pages.

Development

To develop the site, clone the repository and then build with jekyll:

bundle exec jekyll serve

Important Notes

The "posts" page under the posts folder is intentionally separate from the other pages in pages because the pagination plugin needs to find an index.html to parse. Please don't rename or change the location of this file.

Credit

The original template was from bootstrap-clean-jekyll and has been simplified and updated for this case.

rse-escience-2022-vsoch-template's People

Contributors

mrmundt avatar

Watchers

 avatar

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.