Merge pull request #1 from starling-lab/copilot/move-lab-website-to-github-pages

Migrate Starling Lab website to GitHub Pages

Author: sahilsid

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,41 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at `[email protected]` or `[email protected]`. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org/), version 1.4, available at http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contribution Guidelines
+
+## Issues
+
+Issues regarding how the website (`starling.utdallas.edu`) is displayed must include:
+
+* [ ] Operating System
+* [ ] Web Browser & Version
+* [ ] Screenshots (if appropriate)
+
+Issues with a Wiki Page or specific content must include:
+
+* [ ] Link to the page
+* [ ] Description of the problem
+
+## Pull Requests
+
+With some exceptions, pull requests should only be submitted by members of the StARLinG Lab. Pull requests submitted by non-lab members are welcome, but should be reasonable (e.g. do not add yourself to the 'People' page if you do not actually work with us 😧 ). Corrections or clarifications for Wiki pages are an example of a "reasonable" pull request change.
+
+Pull requests should contain:
+
+* [ ] Summary of changes

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+Issues regarding how the website `starling.utdallas.edu` is displayed must include:
+
+* [ ] Operating System
+* [ ] Web Browser & Version
+* [ ] Screenshots (if appropriate)
+
+Issues with a Wiki Page or specific content must include:
+
+* [ ] Link to the page
+* [ ] Description of the problem
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1 @@
+* [ ] Summary of changes

.github/docs/README.md

@@ -0,0 +1,14 @@
+# Changing the Website Over Time
+
+by: [Alexander L. Hayes (@batflyer)](https://github.com/batflyer/)
+
+Websites should naturally change over time, this guide is meant to help make the process simpler.
+
+## Blog Posts
+
+## Wiki Updates
+
+Copy the template to the `_boostsrlwiki` directory, alter the contents, name it appropriately (including the correct number), update `_data/navigation.yml` accordingly.
+
+* Adding an "Advanced BoostSRL" page: [advanced-boostsrl-template.md](docs/advanced-boostsrl-template.md)
+* Adding an "Applications" page: [applications-template.md](docs/applications-template.md)

.github/docs/advanced-boostsrl-template.md

@@ -0,0 +1,46 @@
+---
+title: "Title Should be in Quotes"
+author: 
+permalink: /softwares/boostsrl/wiki/NAME-OF-THE-PAGE/
+excerpt: "This should be a short summary of the pages contents, search engines love these."
+---
+
+### Overview
+
+Provide some motivation for what is being solved, and how this helps to solve it.
+
+<button class="btn btn--primary btn--large" onclick="topOfPage()">Table of Contents</button>
+
+### Parameters
+
+* `-flag1`: What flag one does.
+* `-flag2`: What flag two does.
+
+`java -jar boostsrl.jar -l -flag1 -flag2 -target advisedBy -train train/`
+
+<button class="btn btn--primary btn--large" onclick="topOfPage()">Table of Contents</button>
+
+### Dataset (if Relevant)
+
+Download: [NameOfDataset.zip](https://github.com/boost-starai/BoostSRL-Misc/blob/master/Datasets/.../....zip?raw=true) (*Size* KB)
+
+* `md5sum`: 
+  <p style="word-break: break-all;">stringoflettersandnumbers</p>
+
+* `sha256sum`: 
+  <p style="word-break: break-all;">stringoflettersandnumbers</p>
+
+<button class="btn btn--primary btn--large" onclick="topOfPage()">Table of Contents</button>
+
+### References
+
+1. Authors, Year, Name, Conference.
+2. Authors, Year, Name, Conference.
+
+<button class="btn btn--primary btn--large" onclick="topOfPage()">Table of Contents</button>
+
+<script>
+function topOfPage() {
+    $('html, body').animate({ scrollTop: 0 }, 'fast');
+}
+</script>

.github/docs/applications-template.md

@@ -0,0 +1,24 @@
+---
+title: "Title Should be in Quotes"
+author: 
+permalink: /softwares/boostsrl/wiki/NAME-OF-THE-PAGE/
+excerpt: "This should be a short summary of the pages contents, search engines love these."
+---
+
+### Overview
+
+Motivation for the problem that was solved.
+
+### Example Problem
+
+Include images, figures, and a link to the repository where the code is.
+
+### References and Further Reading
+
+<button class="btn btn--primary btn--large" onclick="topOfPage()">Table of Contents</button>
+
+<script>
+function topOfPage() {
+    $('html, body').animate({ scrollTop: 0 }, 'fast');
+}
+</script>

.github/workflows/jekyll.yml

@@ -0,0 +1,58 @@
+# This workflow builds and deploys a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main", "master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1' # Use Ruby 3.1 for better compatibility with GitHub Pages
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,8 @@
+# Emacs backup files
+*~
+
+_site/
+.sass-cache/
+.jekyll-metadata
+vendor/bundle/
+.bundle/

Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+gem "jekyll", "~> 3.9"
+gem "minimal-mistakes-jekyll"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+  gem "jekyll-redirect-from"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0" if Gem.win_platform?
+
+gem 'jekyll-include-cache'
+
+gem "webrick", "~> 1.7"