Skip to content

Commit

Permalink
To be continued: US-RSE'24 website start
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmundt committed Sep 26, 2023
0 parents commit b7f2841
Show file tree
Hide file tree
Showing 110 changed files with 38,156 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .circleci/circle_urls.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
BASEURL=https://output.circle-artifacts.com/output/job/${CIRCLE_WORKFLOW_JOB_ID}/artifacts/${CIRCLE_NODE_INDEX}/usrse.github.io/usrse23
sed -i "8 s,.*,baseurl: $BASEURL,g" "_config.yml"
sed -i "7 s,.*,url: \"\",g" "_config.yml"
79 changes: 79 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
version: 2.1

workflows:
version: 2

# The build workflow will build a preview for the site, intended for PRs
build:
jobs:
- build-site:
filters:
branches:
ignore: gh-pages

install: &install
name: Install dependencies for build
command: |
$HOME/conda/bin/pip install -r ~/repo/.circleci/requirements.txt
install_python_3: &install_python_3
name: Install Python dependencies
command: |
ls $HOME
if [ ! -d "/home/circleci/conda" ]; then
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
/bin/bash Miniconda3-latest-Linux-x86_64.sh -b -p $HOME/conda
export PATH=$HOME/conda/bin:$PATH
else
echo "Miniconda 3 is already installed, continuing to build."
fi
build_jekyll: &build_jekyll
name: Jekyll Build
command: |
if [ -z "$CIRCLECI_TRIGGER" ]; then
echo "Building US-RSE'23 website for Preview"
cp ~/repo/.circleci/circle_urls.sh ~/repo/circle_urls.sh
cd ~/repo
chmod u+x circle_urls.sh
bash circle_urls.sh
bundle exec jekyll build
else
echo "Nightly build detected, preview not needed."
fi
jobs:
build-site:
docker:
- image: cimg/ruby:3.1
working_directory: ~/repo
environment:
- JEKYLL_ENV: production
- NOKOGIRI_USE_SYSTEM_LIBRARIES: true
- BUNDLE_PATH: ~/repo/vendor/bundle
steps:
- checkout
- restore_cache:
keys:
- v1-dependencies
- rubygems-v1
- run: *install_python_3
- run: *install
- save_cache:
paths:
- /home/circleci/conda
key: v1-dependencies
- run:
name: Bundle Install
command: |
cd ~/repo
bundle check || bundle install
- save_cache:
key: rubygems-v1
paths:
- vendor/bundle
- run: *build_jekyll
- store_artifacts:
path: ~/repo/_site
destination: usrse.github.io/usrse23
1 change: 1 addition & 0 deletions .circleci/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pyaml>=17.12.1
2 changes: 2 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_site/
Gemfile.lock
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!--- Thank you for opening a pull request! Here are some helpful tips:
1. To solicit reviewers:
the Committee chairs are automatically notified when you open this pull request
If you need additional reviewers you can:
(if you have permission to do so) assign the label "reviewers-needed"
if you are on the usrse slack, post a link to your PR there and ask for reviewers
2. To get help:
you can ask the question directly in this pull request for the Committee chairs
-->

<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail. -->


## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] (Committee Chairs Only) I have posted the link for the PR in the usrse slack (#usrse-2024-conference-planning-committee) to ask for content reviewers
- [ ] I have previewed changes locally
- [ ] I have updated the README.md if necessary

cc **ADD GITHUB HANDLES HERE**

46 changes: 46 additions & 0 deletions .github/workflows/linting.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Check Spelling and URLs

on: [pull_request]

# Kill concurrent jobs from the same PR/branch - only one will run at a time
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
urlcheck:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Check Spelling
uses: crate-ci/typos@12c64918956d94e55a2ca8c5cbca111e759f5654 # version 1.13.8
with:
files: ./_posts ./pages ./README.md ./index.html
config: ./.github/workflows/typo_config.toml

- name: URLs-checker

uses: urlstechie/[email protected]
with:
# A comma-separated list of file types to cover in the URL checks
file_types: .md,.py,.yml

# Choose whether to include file with no URLs in the prints.
print_all: false

# More verbose summary at the end of a run
verbose: true

# How many times to retry a failed request (defaults to 1)
retry_count: 3

# Google Forms is having enormous timeouts
timeout: 10

# Exclude these patterns from the checker
exclude_patterns: supercomputing.org,https://www.hyatt.com/shop/chixl?location=Hyatt%20House%20Chicago%20%2F%20West%20Loop-Fulton%20Market&checkinDate=2023-10-15&checkoutDate=2023-10-19&rooms=1&adults=1&kids=0&corp_id=g-uicf

# Exclude these files from the checker
exclude_files: README.md,SocialNetworks.yml,_config.yml,tests/test_,.github/workflows
5 changes: 5 additions & 0 deletions .github/workflows/typo_config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[default.extend-words]
# Don't correct the name "Vas"
Vas = "Vas"
# protocoL triggers error
protoco = "protoco"
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# project
_site
.sass-cache
.vagrant
Gemfile.lock

# general
.DS_Store
Thumbs.db
ehthumbs.db

# python
__pycache__
*.pyc

*~
16 changes: 16 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
layout: default
title: 404 - Page not found
permalink: /404.html
---

<div class = "row">
<div class="col-md-6" style="margin:auto">
<img src="{{ site.baseurl }}/assets/img/new_trans_circular_logo.png" alt="404 Logo">
</div>
<div class ="col-md-6" style="margin:auto">
<h1>Sorry about that...</h1>
<p>Seems that we've misplaced that URL or it's pointing to something that doesn't exist.
<a href="{{ site.baseurl }}/">Let's try again!</a></p>
</div>
</div>
187 changes: 187 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
# Contributing to US-RSE Conference 2024 Website

If you are comfortable working with forks, branches, and pull requests, please
follow the below guidance. If you are not, please reach out to the Outreach/Website
committee chairs:

- TBD

The general workflow for everyone interacting with the US-RSE Conference website
is described in the following.

## Contents

1. [Introduction](#introduction)
1. [Forking](#forking)
1. [Keeping Your Fork Updated](#keeping-your-fork-updated)
1. [Creating Issues](#creating-issues)
1. [Markdown](#markdown)
1. [Working on Issues](#working-on-issues)
1. [When Work Begins](#when-work-begins)
1. [As Work Continues](#as-work-continues)
1. [When Work is Complete](#when-work-is-complete)
1. [Closing Old Issues](#closing-old-issues)
1. [Pull Requests](#pull-requests)
1. [Reviewers](#reviewers)
1. [Work-in-Progress](#work-in-progress)
1. [Merging](#merging)

## Introduction

We recommend using a `fork and branch` approach to contribution. In this method,
you will create a personal fork of the main US-RSE Conference repository,
make your changes locally in your own branches, and then open pull
requests to merge changes back into the main repository.

[↑ Contents](#contents)

### Forking

To create a fork, go to the [main repository](https://github.com/USRSE/usrse23)
and click the `Fork` button in the top-right. You can choose under what username
or organization the fork is made; we recommend your personal account.

After it's creation, you will now have a local fork of the repository.

See [GitHub's Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
for more details.

[↑ Contents](#contents)

### Keeping Your Fork Updated

After your fork is created, you will need to make sure it stays up-to-date to
avoid conflicts when you make changes.

See [GitHub's Documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)
for the various ways to keep your fork in sync.

[↑ Contents](#contents)

## Creating Issues

[Create issues in GitHub](https://github.com/USRSE/usrse23/issues)
for any work that needs to be done. This can include, but is not limited to:

- Bugs
- Enhancements
- Discussions

[↑ Contents](#contents)


### Markdown

[Markdown](https://en.wikipedia.org/wiki/Markdown) is a lightweight markup
language with plain text formatting syntax. GitHub uses a form of it for
rendering issue and pull request descriptions and comments, wiki pages, and
any files in your repositories with a `.md` extension (such as this one). For
more details on what's possible with GitHub-flavored Markdown, [see GitHub's
documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).

[↑ Contents](#contents)


## Working on Issues

### When Work Begins

Make sure your local `main` branch is up-to-date by running

```bash
git checkout main
git pull remote main
```

> **Note:** You should never be making commits on your `main` branch, as
> all changes will be making it into `main` via [pull requests](#pull-requests).
Once `main` is updated, you then create a feature branch off of it with `git
checkout -b <branchName>`.

We recommend using the format `username/description` when naming the branch
for clarity on who is doing the work and what type of work is being completed.
For example, `mrmundt/add-contributing`.

[↑ Contents](#contents)


### As Work Continues

Do whatever work is necessary to address the issue you're tackling. Divide your
work into logical, compilable commits. Feel free to commit small chunks of
work early and often in your local repository and then use `git rebase -i` to
reorganize your commits before sharing.

[↑ Contents](#contents)


### When Work is Complete

While working on your feature in your local repository, other commits likely
made it into the remote `main` branch. There are a variety of ways to merge
these changes into your local feature branch. One possibility is

```bash
git checkout main
git pull --ff-only
git checkout <branchName>
git rebase main
```

though there are others that are equally valid.

Once you are done, [create a pull request](#pull-requests) (see below).

[↑ Contents](#contents)

### Closing Old Issues

If at any point you encounter an issue that will not be worked in the
foreseeable future, it is worthwhile to close the issue such that you can
maintain a reasonable backlog of upcoming work. Do be sure to include in the
comments some explanation as to why the issue won't be addressed.

[↑ Contents](#contents)



## Pull Requests

The preferred way changes get into `main` is through pull requests. When you've
completed work on an issue, push your branch to the remote with `git push -u
<remoteName> <branchName>`, and then create a pull request.

[↑ Contents](#contents)

### Reviewers

We recommend having your pull request reviewed by at least two other team
members. The first should be a member of the Outreach/Website committee.
The second should be another member of the team for which the change is being
completed (e.g., Program Committee). Work with your reviewers to get your
changes into an acceptable
state.

[↑ Contents](#contents)

### Work-in-Progress

You may wish to have your changes reviewed by colleagues before they are ready
to be merged into `main`. To do so, create a pull request as usual, but
insert "[WIP]" at the beginning of the Title.

You may also create a "Draft" request (see [GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests)).

GitHub will not allow you to merge a Draft or WIP request.

[↑ Contents](#contents)


### Merging

When the reviews are finished and all changes approved, your pull request will
be merged by one member of the Outreach/Website committee.

[↑ Contents](#contents)

Loading

0 comments on commit b7f2841

Please sign in to comment.