This repo contains the source code for:
The site uses Jekyll (based on Centrarium theme). We
Table of Contents:
- Raft Website
Welcome to Raft! We work together to solve hard problems and we're glad you've decided to join our journey. In order for you to be added to Our Team page, please follow these four steps:
0. Open a new issue with title Adding <your name>
- Create a new branch from
master
- Update the
_data/members.yml
to add your details and add a new file to the_about/
folder - Send a Pull Request from your newly created branch in (1) to
master
and tagbarakstout
,meissadia
, oromnipresent07
as reviewers
Below is a detailed explanation of each step:
- If you aren't already part of the Raft GitHub Org, ping Barak Stout on Mattermost (MM) your GitHub username.
- Create an issue by going to this URL - https://github.com/raft-tech/raft-tech.github.io/issues/new
- Go to this URL - https://github.com/raft-tech/raft-tech.github.io
- Click master, type a unique branch name, and click
Create Branch
- You will notice
Branch Created
in top left
- Press the letter
t
on your keyboard and notice you'll see a cursor prompting you to type - Type
members.yml
- Click on the file name
- Click the edit icon on the right
- Ensure it says in
your branch name
- Scroll all the way to the bottom of the file and copy/paste the following:
- id: firstname_lastname
permalink: /about/firstname_lastname
full_name: Firstname Lastname
role: Your Title
image: <firstname_lastname.jpg> or null (if you don't want your image up)
- Once pasted, change the contents
- Add details at the bottom of the page (Ensure the changes are going to correct branch and click
Commit Changes
) - Now similarly go to
_about
folder and create a new file - Name the file
firstname_lastname.md
(change it based on your details) - Copy/Paste below into the editor
---
id: firstname_lastname
permalink: "/about/firstname_lastname"
full_name: Firstname Lastname
title: About - Firstname Lastname
role: Your Title
about: Short bio about yourself
github: your github handle
linkedin: yourlinkedin url
homepage: your homepage url - if applicable
featimg: "/assets/aboutBanner1.jpg" <-- do not change
layout: about/profile <-- do not change
---
- Change the contents relative to your details
- Fill in details and click
Commit New File
- If you're adding your image, then follow the same process to add an image file to
assets/profiles/
namedfirstname_lastname.jpg
- Go to https://github.com/raft-tech/raft-tech.github.io/branches
- Locate your branch and click
New Pull Request
- Change
master
tostaging
, copy/paste the URL for the issue you created in (0) and type in the body of the PRAddresses <copy paste URL of the ticket>
, and clickCreate pull request
- Ensure the commits are going into
staging
fromyour branch
and the number of files changed is still 2 - Tag
barakstout
,meissadia
, oromnipresent07
as reviewers - The reviewers will review and merge your Pull Request. Once that is done, the changes will show up on the staging site https://raft-website.herokuapp.com/ . Once the changes look good to the reviewer, the reviewer will open a Pull Request for the
staging
branch to be merged into themaster
. Once that Pull Reuqest is merged in by the reviewer, the changes will show up on the main website - http://goraft.tech/
- Make your feature branch
- Append changes to
_data/members/yml
- id: firstname_lastname
permalink: /about/firstname_lastname
full_name: Firstname Lastname
role: Title
image: firstname_lastname.jpg or null if you don't want your image up
- Add new file to
/_about
titled/_about/firstname_lastname.md
---
id: firstname_lastame
permalink: "/about/firstname_lastname"
full_name: Firstname Lastname
title: About - Firstname Lastname
role: Your title
about: Your Bio
github: "Your GitHub URL"
linkedin: "Your Linkedin URL"
featimg: "/assets/aboutBanner1.jpg" <-- do not change
layout: about/profile <-- do not change
---
- If you wanted to add your image, title it
firstname_lastname.jpg
and put it inassets/profiles/
- Open a PR for your feature branch to be merged to
staging
. Review your PR. Tagbarakstout
,meissadia
, oromnipresent07
as reviewers.
A blog post comprises for three things:
-
Have your blog post in Markdown format. Copy/Paste the below into the editor.
--- layout: post title: "Really long blog title" short_title: "Shorter title" date: 2021-07-14 categories: featimg: /assets/images/featimage/... bgimg: /assets/images/bgimg/... author: Angela Milash ---
-
Open a new issue
- (a) The title of the issue should be
Name of the blog title - by John Doe
- (b) The body of the ticket drag and drop the two images -- one for the index page and another for the actual blog page (exampel: here).
- (a) The title of the issue should be
-
Click
Submit New Issue
-
Tag either
barakstout
,meissadia
, oromnipresent07
for review
-
Have your blog post in Markdown format. Copy/Paste the below into the editor.
--- layout: post title: "Really long blog title" short_title: "Shorter title" date: 2021-07-14 categories: featimg: /assets/images/featimage/... bgimg: /assets/images/bgimg/... author: Angela Milash ---
-
Open a PR that:
- add the new markdown file to
_/posts
in the formatYYYY-DD-MM-title-of-the-post.md
- add the background image to
assets/images/bgimage
- add the index image to
assets/images/featimage
- add the new markdown file to
-
Open a PR for
barakstout
,meissadia
, oromnipresent07
for review
To run the site locally from source, you will need to Install Jekyll for which you'll need Ruby. We recommend:
➜ curl -sSL https://get.rvm.io | bash -s stable
➜ ~ rvm version
rvm 1.29.12 (latest) by Michal Papis, Piotr Kuczynski, Wayne E. Seguin [https://rvm.io]
➜ ~ rvm install "ruby-2.6.4"
cd ~/
mkdir raft
cd raft
git clone git@github.com:raft-tech/raft-tech.github.io.git
cd raft-tech.github.io.git
gem install bundler
bundle install
bundle exec jekyll pagemaster --no-permalink about
#If you are running this with ruby 3.0+, run the command 'bundle add webrick'
bundle exec jekyll serve
# raft website avilable at http://localhost:4000
M1 Based Macs follow the instructions here to install ruby
Simply clone the repo cd into the root folder in terminal and run docker-compose up
point your browser to http://localhost:4000
and get to work.
Build and deploy locally using Docker
docker build . -t=raft-website
docker run -p 80:80 raft-website
Update the Image
value in raft-website-deploy
and deploy raft-website
on Kubernetes:
kubectl apply -f kubernetes/raft-website-deploy.yaml
kubectl apply -f kubernetes/raft-website-svc.yaml
To get the external IP:
kubectl get svc raft-website-svc