EE External Website Content Management Manual

📋 Introduction

This manual provides step-by-step instructions for managing content on our department website. The website uses Jekyll and is automatically deployed through GitHub. You will use GitHub Desktop to submit your changes.

🛠 Prerequisites Setup

1. Install Required Software

• GitHub Desktop: Download from desktop.github.com
• Text Editor: Use Notepad, Notepad++, or any simple text editor
• File Explorer: Standard Windows File Explorer

2. Initial Repository Setup (One-time only)

1. Open GitHub Desktop
2. Click File → Clone Repository
3. Select our website repository from the list
4. Choose a local folder (e.g., C:\Website\)
5. Click Clone

📁 Understanding the Folder Structure

your-website-folder/
├── __news_/
├── __events_/
├── _faculty/
├── _data/staff.yml
├── assets/images/
│   ├── news/
│   ├── faculty/
│   └── staff/

📝 General Workflow for All Tasks

Step 1: Update Local Repository

1. Open GitHub Desktop
2. Make sure you’re in the correct repository
3. Click Fetch origin to get latest changes

Step 2: Edit Content

1. Navigate to the correct folder using File Explorer
2. Copy the existing file as a template (if available)
3. Edit using Notepad
4. Save with correct filename

Step 3: Submit Changes

1. Return to GitHub Desktop
2. You’ll see your changed files listed
3. Check the box next to files you want to submit
4. Write a descriptive commit message in the bottom left
   • Example: “Added news about annual conference”
5. Click Commit to main
6. Click Push origin to upload changes

Step 4: Verify Deployment

1. Wait 2-3 minutes after pushing
2. Visit our website to confirm changes appear
3. If issues occur, contact the technical team

📰 1. Add News Item

A) With Photo

Prepare the Image

1. Resize photo to approximately 150x150 pixels
2. Save in assets/images/news/ folder
3. Name format: YYYY-MM-DD-descriptive-name.jpg
   • Example: 2024-03-15-annual-conference.jpg

Create News File

1. Go to _news/ folder
2. Copy an existing news file as template
3. Create new file named: YYYY-MM-DD-title-of-news.md
   • Example: 2025-11-27-mahesh-kumar-ieee-fellowship.md

Edit the File

---
title: "Prof. Mahesh Kumar becomes IEEE Fellow"
date: 2025-11-27
image: /assets/images/faculty/mahesh-kumar.png
image_description: "Prof. Mahesh Kumar"
layout: news
classes: wide
---
Congratulations to Prof. Mahesh Kumar on becoming an **IEEE Fellow** for outstanding contributions in Power Engineering.

You can add multiple paragraphs.
Type image description clearly.
- Bullet points work too
- Second bullet point

**Bold text** and *italic text* are supported.

B) Without Photo

Follow same steps as above, but remove the image line from the header:

---
title: "Prof. Mahesh Kumar becomes IEEE Fellow"
date: 2025-11-27
layout: news
classes: wide
---

🗓️ 2. Add Event

File Location: _events/

A) MS Seminar

1. Copy template from existing MS seminar
2. File name: YYYY-MM-DD-ms-seminar-topic.md
3. Use this format:

---
title: "Exploration of Dual Issue in-order designs based on Shakti C-Class"
date: 2025-11-26
time: "3:00 PM"
venue: "CSD-308"
speaker: "Mr. MOUNA KRISHNA GADHIRAJU (EE22S082)"
guide: "Dr. Nitin Chandrachoodan"
co_guide:
category: "ms"
layout: single
---
**Abstract:**
The Shakti C-Class is an open-source processor built on the RISC-V architecture. It features a simple, in-order, single-issue, 6-stage pipeline design, while incorporating several elements typically found in superscalar processors, such as a scoreboard and deeper pipeline buffers to enhance performance. However, these features are found to be underutilized in the baseline architecture. To address this, we present a case study on upgrading the single-issue pipeline to a dual-issue pipeline with details of how each micro-architectural change affected the area and performance. We achieve a best case CoreMark score of 3.74 CM/MHz, representing a 42.2% improvement, with 7.6% of area overhead compared to the baseline design.  

DO NOT MODIFY THE CONTENT BELOW IN ANY EVENT

**Event Details**  
**Title:** {{ page.title }}  
**Date:** {{ page.date | date: "%B %d, %Y" }} at {{ page.time }}  
**Venue:** {{ page.venue }}  
**Speaker:** {{ page.speaker }}  
**Guide:** {{ page.guide }}  
**Type:** {{ page.category | upcase }} seminar  

B) PhD Seminar

Same as MS seminar but change: - File name: YYYY-MM-DD-phd-seminar-topic.md - category: phd

C) Other Events

Same as MS/PhD seminar but change: - File name: YYYY-MM-DD-event-topic.md - category: other

👨‍🏫 3. Add New Faculty Member

Step 1: Add Photo

1. Get professional headshot
2. Resize to 150x150 pixels
3. Save as: firstname-lastname.jpg in assets/images/faculty/
   • Example: john-doe.jpg

Step 2: Create Faculty File

1. Go to _faculty/ folder
2. Copy an existing faculty file
3. Create new file: firstname-lastname.md
   • Example: john-doe.md

Step 3: Edit Faculty Details

Make sure that the image name and avatar name are correct and identical

🚫 4. Remove Retired Faculty Member

Delete the file named firtname-lastname.md from _faculty folder

1. Keep the image in images/faculty/ for record. It may be needed for news items. Do not delete them.

✏️ 5. Modify Existing Faculty Details

1. Navigate to _faculty/ folder
2. Find the faculty file (e.g., john-doe.md)
3. Open with Notepad
4. Update any field:
   • Change designation
   • Update office number
   • Add new publications
   • Update research interests
5. Save the file
6. Commit and push changes

👥 6. Add New Staff Member

Step 1: Add Photo

1. Save photo as firstname-lastname.jpg in assets/images/staff/
2. Resize to 150x150 pixels

Step 2: Create Staff File

1. Go to _data/ folder
2. Open staff.yml
3. In the appropriate place, copy paste adn edit accordingly

- name: "Amal Mohan PK"
  position: "Technical Staff"
  email: "amalmohanpk@ee.iitm.ac.in"
  phone: "+91-44-2257-4400"
  office: "ESB 210D [EE Office]"
  photo: "amal.png"

Step 3: Edit Staff Details

You can edit the above file when needed

🚫 7. Remove Retired Staff Member

1. Remove the section in _data/staff.yml file
2. Keep photo in images/staff/ for records

⚠️ Troubleshooting Guide

Common Issues and Solutions

File Naming Conventions

• Always use lowercase
• Use hyphens, not spaces
• Dates format: YYYY-MM-DD
• Faculty/Staff: firstname-lastname.md

Commit Message Examples

• ✅ Good: “Added news about open house event”
• ✅ Good: “Updated Dr. Smith’s office number”
• ❌ Bad: “update” or “fix” or “changes”

📞 Support

Immediate Assistance

• Technical Issues: Contact Harmeet Singh
• Content Questions: Ask Department Head

Regular Maintenance

• Update news weekly
• Review faculty/staff pages quarterly
• Archive old events monthly

🔄 Quick Reference Card

1. Open GitHub Desktop → Fetch origin
2. Edit files in correct folders
3. Save with proper naming
4. Return to GitHub Desktop → Check changes
5. Write commit message → Commit → Push
6. Wait 5 minutes → Verify on website