browndatasci/ccv_website_dev repository overview

⁠CCV Website

This is the repo for Brown CCV's static website built with Hugo⁠.

⁠Development

If you want to contribute to this project follow these steps:

• Install Hugo⁠.

brew install hugo

• Clone the repo and install Node dependencies:

git clone https://github.com/brown-ccv/ccv-website.git
cd ccv-website
npm install

To start the server:

npm run serve # Preferred method. This will populate the citations (more on this later.)
#or
hugo serve [-D --ignoreCache --disableFastRender] <- optional flags

Go to localhost:1313/

To build the site into the public/ folder. This generates all the files needed to publish the side, but doesn't start the server.

npm run build
#or
hugo

docker build -t ccv-website .
docker run -d -p 8080:80 ccv-website

Go to localhost:8080

⁠Updating Content

The code is on GitHub⁠. We will use the gitflow branching model.

GitHub: If you want to add or update content, create a feature branch from develop. When done, send a PR to develop. The develop (staging) branch will deploy to datasci.brown.edu/ccv-dev/. The staging site should then be reviewed and merged into master for production.

⁠Creating New Content

Sections:

• News (Blog) - https://www.medium.com/brown-ccv⁠
• Showcase Projects
• Documentation - https://app.gitbook.com/@brown-cis/spaces⁠
• People
• Opportunities

⁠News

This is the blog section. It's now on Medium⁠

⁠Pojects to Showcase on Home Page

Project, labs, initiatives, groups, collaborations, or anything we want to showcase. Items under this section will show up on the home page's carousel.

---
title: "{{ replace .Name "-" " " | title }}"
date: {{.Date}}
draft: false
team: ""
text: ""
image: "/images/<image.png>"
href: ""
cfa: "Launch the App" # call for action button: Read More, Learn More, Launch the App, More on Github...
---

hugo new content/english/projects/project.md

⁠Documentation

Documentation is managed with Gitbook. Check the docs here⁠

⁠The data folder

⁠People

data/people.yaml

- name: Ashley S. Lee
  team: Advanced Research Computing
  title: Data Scientist
  github_username: alee35
  brown_directory_uuid: 380094e2-6f9d-47cf-91ce-e636876a58cf
  bio: "Ashley received training in Biology and Data Science at the University of Virginia
    and dabbled in a variety of careers including Bus Driver, Bagel Slinger, and Chief
    Fiduciary at Smoothie King. She enjoys food and beverage, bodies of water, jokes,
    caring for her beloved dog and plants, and resenting her cat."
  image: ashley.jpg

⁠Opportunities

data/opportunities.yaml

- title: Research Services Support Specialist
  team: CCV Operations
  subteam: User Services
  link: "https://brown.wd5.myworkdayjobs.com/en-US/staff-careers-brown/job/180-George-Street/Research-Services-Support-Specialist_REQ151702"

⁠Apps

Fetching apps data requires a .env file (template below).

• The .env file is included in .gitignore and should never be committed.
• You can obtain a Github Access Token by following these instructions⁠.

GITHUB_TOKEN=
GITHUB_USER=
ORGANIZATION=brown-ccv,compbiocore

⁠CCV Bot - Calendar and Oscar/Stronghold Account Request.

⁠Events

To add events to the website, simply invite [email protected] to your event. Make sure to set a location, have a displayable name, and a nice typo-free, short description. The Bot needs to accept the invitation before it can be displayed on the website.

In addition, the Bot checks the calendar every day around 7:25am. It combines the events of the day into one email and sends it out to [email protected].

The Bot will also create a deskpro ticket when users request an account on Oscar or Stronghold.

⁠Guidelines for writing Markdown content

Find detailed information on how to write your markdown content and include shortcodes specific for CCV's website here⁠.