Systems Optimization Laboratory @ Penn State — Website Contributor Guide

Welcome to the Systems Optimization Lab website repository!
This README explains how to update your personal profile, add news items, and manage publications. Follow these instructions to keep our site accurate and up to date.

---

Table of Contents

1. Editing Your Profile
2. Adding or Editing News Items
3. Adding or Editing Publications
4. Submitting Your Changes
5. Need Help?

---

1. Editing Your Profile

Each lab member has a profile file in _pages/about/.

To update your profile:

1. Locate your profile file (e.g., _pages/about/eduardo.md).
2. Edit the file using Markdown. Update your name, research topic, email, and relevant links.

To update your picture

1. Add image to /assets/img/team
2. Change image name in your profile file

Note: Only .jpg images are compatible for profile pictures. Please ensure your image file uses the .jpg extension.

Profile Template:

## Your Name

_Joined group in [Semester Year]_

Research topic: [Your research topic]

Email: [mailto:your.email@domain.edu](mailto:your.email@domain.edu)
Links: [LinkedIn](https://linkedin.com/in/yourprofile)

3. Save and commit your changes. Use a descriptive commit message (e.g., Update profile for Eduardo Lopez Ledezma).

---

2. Adding or Editing News Items

News items are stored in the _news/ directory as Markdown files.

To add a news item:

1. Create a new file in _news/ named YYYY-MM-DD-title.md.
2. Use this template:

---
title: "Short News Title"
date: YYYY-MM-DD
author: Your Name
---

Brief description of the news item.

To edit an existing news item:

• Open the relevant file in _news/ and make your changes.

---

3. Adding or Editing Publications

Publications are listed in the _publications/ directory.

To add a publication:

1. Create a new file in _publications/ named YYYY-title.md.
2. Use this template:

---
title: "Publication Title"
authors: Author1, Author2, Author3
journal: Journal Name
year: YYYY
doi: https://doi.org/xxxx
---

Short summary or abstract of the publication.

To edit a publication:

• Open the relevant file in _publications/ and update details as needed.

---

4. Submitting Your Changes

To contribute updates or new content to the Systems Optimization Lab website, follow these streamlined steps:

1. Fork & Clone
   Fork the repository to your GitHub account, then clone it to your computer:

git clone https://github.com/your-username/subramanyam-lab.github.io.git
cd subramanyam-lab.github.io

2. Create a Branch
   Make a new branch for your changes:

git checkout -b update-profile

3. Edit Files
   Update your profile, add news, or publications as needed. Follow the templates in the repo for consistency.

4. Commit Changes
   Add and commit with a clear message:

git add .
git commit -m "Update profile for [Your Name]"

5. Push & Open Pull Request
   Push your branch and open a Pull Request on GitHub. Explain your changes briefly.

6. Review
   Respond to any feedback, make adjustments if needed, and wait for merge.

This process keeps the site accurate and ensures every update gets reviewed.

---

Need Help?

Questions or issues? Contact the repository maintainer or open a GitHub issue.

---

Happy contributing!