UT Austin Swarm Lab Page

This is the repository for the Swarm lab page. The site is based on Jekyll and uses GitHub Pages. The site is based upon the template used by the CLeAR Lab at UT Austin. Thanks!

Add yourself!

If you're part of UT Austin Swarm Lab (if you're in the Slack), or collaborate with Dr. Sandeep Chinchali, you can submit a pull request to be added to the website! Please read these steps before you submit a PR.

• Fork this repository and clone it
• Add an entry under the _people directory as follows:
  • Make a file with <your_name>.md
  • Copy paste the contents from people_template.md
  • For the first 5 lines that describe the page:
    • name: Your Name
    • position: One of the following - pi|postdoc|gradstudent|undergrad|researchstaff|visiting|others|alumni
    • avatar: A picture of you added to the images/people directory
  • Fill in the rest of your details according to the template or how you see fit
  • Remove the instruction lines in bold, except Office
  • Optionally, you can add your resume/CV to the documents directory
• Finally, submit a pull request to the source branch of this repository and we'll merge it ASAP
• If you need help, text Sundar (@ss26) in the Swarm Lab Slack or send an email to [email protected]

Add your publication!

Just copy the BibTex entry of your paper from Google Scholar and paste it in _bibliography/references.bib, after the first 4 lines.

Publish an update

If you're part of the UT Austin Swarm Lab organization and you've made a change, reviewed and merged a pull request, you can do the following to publish your updates to the website. This assumes you have a local version of this repository on your PC.

• git pull the most recent merged changes locally
• rake publish to convert the files in source branch to static site in master branch. This automatically calls a GitHub action to deploy the contents of master branch to https://utaustin-swarmlab.github.io!
• Again, if this doesn't work, ping Sundar!

How to add posts

• Directly edit on Github, you can simply go to _posts and click New file then put some markdown file e.g. YYYY-MM-DD-post_name.md and start writing blog post. Github also allows you to preview it so it's nice for people who don't want to clone the repo.

• Template: see markdown files in ./_posts/ for examples. You can copy paste the template and start writing your own post. Please make sure you put the header correctly.

• Clone the repository, kind of the same as directly add post on Github. You just have to clone the repository. Then add new post file, commit and push to the repo. Please make all changes via Pull Request.

The changes will take approximately half a minute to render.

TODO

• Add SEO?