Skip to content

Commit c4601a1

Browse files
Add llvm.org website redesign project final blogpost (#263)
* Add llvm.org website redesign project final blogpost * Update llvm.org website redesign blog banner
1 parent 8a173e0 commit c4601a1

3 files changed

+85
-1
lines changed

Diff for: _posts/2024-05-11-llvm-org-website-redesign-project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This initiative will streamline navigation, improve accessibility, and update
77
content, transforming LLVM.org into a more user-friendly resource."
88
sitemap: false
99
author: Chaitanya Shahare
10-
banner_image: /images/blog/gsoc-banner.png
10+
banner_image: /images/blog/gsoc-llvm-org-website-redesign-banner.png
1111
permalink: blogs/gsoc24_chaitanya_shahare_introduction_blog/
1212
date: 2024-05-11
1313
tags: gsoc llvm website
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: "LLVM.org Website Redesign Project Wrap Up"
3+
layout: post
4+
excerpt: "The LLVM.org website redesign project, part of GSoC
5+
2024, aimed to modernize and enhance usability of llvm.org website for its community of developers. This initiative will streamline navigation, improve accessibility, and update content, transforming LLVM.org into a more user-friendly resource."
6+
sitemap: false
7+
author: Chaitanya Shahare
8+
banner_image: /images/blog/gsoc-llvm-org-website-redesign-banner.png
9+
permalink: blogs/gsoc24_chaitanya_shahare_introduction_final_blog/
10+
date: 2024-11-04
11+
tags: gsoc llvm website
12+
---
13+
14+
### Introduction
15+
16+
Hello! I’m Chaitanya, and as part of my Google Summer of Code (GSoC) 2024, I contributed to the LLVM project by redesigning the LLVM.org website. My
17+
project, titled *Improving LLVM.org Website Look and Feel*, focused on creating
18+
a modern, accessible, and efficient user experience for the LLVM community.
19+
Working with Hugo as a static site generator, I aimed to improve content
20+
organization, enhance site flexibility, and make the content management process
21+
more accessible for contributors.
22+
23+
- **Contributor:** [Chaitanya Shahare](https://github.com/Chaitanya-Shahare)
24+
- **Mentors:** [Tanya Lattner](https://github.com/tlattner)[Vassil Vassilev](https://github.com/vgvassilev)
25+
- **Project:** [Improve LLVM.org Website Look and Feel](https://llvm.org/OpenProjects.html#llvm_www)
26+
27+
### Project Overview
28+
29+
As part of Google Summer of Code 2024, my project focused on revamping the LLVM.org website to deliver a modern, accessible, and user-friendly experience. The project aimed to address key areas for improvement, including a refreshed design, better content organization, and simplified maintainability for developers and contributors. Using the Hugo static site generator, this project established a new modular structure and enhanced configurability for the LLVM website.
30+
31+
### Project Goals
32+
33+
The primary goals of this project included:
34+
- **Creating a New Hugo-Based Theme**: Building a modular, reusable theme with a responsive and accessible design.
35+
- **Improving Content Organization**: Streamlining the site’s structure to simplify navigation and information discovery.
36+
- **Using Yaml Datafiles**: Making the website’s content management accessible, using yaml data files. Separation of data & styles.
37+
38+
### Key Achievements
39+
40+
Over the summer, the following components were developed to create the new LLVM website:
41+
42+
1. **Custom Hugo Theme Development**
43+
- Developed a reusable theme using Hugo with SCSS, focused on modularity and extendability.
44+
- Built custom shortcodes for key website features, such as table of contents, project cards, and events, making page creation simple and uniform.
45+
46+
2. **Dynamic Content Pages**
47+
- Created dynamic, YAML-driven pages for subprojects, GSoC projects, Developer Meetings, and Publications. This setup allows for easy additions or updates directly from YAML files without editing HTML or markdown code.
48+
49+
3. **Comprehensive Documentation**
50+
- Created extensive documentation for configuring, updating, and maintaining the site, making it easier for future contributors to onboard and extend.
51+
- Set up and deployed a staging environment for thorough testing and community feedback.
52+
53+
4. **Repository Structure and Configurability**
54+
- Set up two repositories: one for the main website and another for the Hugo theme, making the theme reusable across other LLVM subprojects, such as Clang.
55+
- Ensured the website’s key elements, such as the homepage, logo, and footer, are easily configurable via `hugo.yml` and markdown files.
56+
57+
### Impact on the Community
58+
59+
This project is an important step towards providing a more accessible and visually engaging website for the LLVM community. The modular approach with Hugo allows for rapid content updates and new page additions. The new website structure, with improved design and user experience, is expected to better serve LLVM’s diverse user base.
60+
61+
### Challenges and Learning
62+
63+
Throughout the project, there were technical challenges, especially regarding implementing reusable components and ensuring the website remained modular. The learning process involved optimizing the Hugo theme for usability, maintaining code quality, and working with community feedback to refine the designs.
64+
65+
### Future Directions
66+
67+
- **Expanding Content**: Incorporating more LLVM dev meetings pages.
68+
- **Continuous Integration**: Add CI for checking broken links, build status, assets' sizes, etc.
69+
- **Clang Website**: Applying this reusable theme structure to create a website for Clang.
70+
- **Community Contributions**: Engaging with the community to ensure continuous content updates and feedback on the website’s evolving structure.
71+
72+
### Acknowledgements
73+
74+
I am incredibly grateful to my mentors, the LLVM community & the Compiler Research team for their guidance, feedback, and encouragement throughout this project. Their support was invaluable in shaping the project and addressing challenges along the way.
75+
76+
### Project Links
77+
78+
- **New Website Link:** [www-new.llvm.org](https://www-new.llvm.org/)
79+
- **GitHub Repositories:**
80+
- Website Repo: [llvm/www-new](https://github.com/llvm/www-new)
81+
- Hugo Theme Repo: [llvm/www-template](https://github.com/llvm/www-template)
82+
- **Personal GSoC Series for detailed logs**: [Project Diary](https://blog.chaitanyashahare.com/series/gsoc/)
83+
84+
This project has been a rewarding journey, and I look forward to seeing the LLVM website continue to evolve and grow with the community's needs. Thank you, Google Summer of Code, LLVM & Compiler Research for this incredible experience!
462 KB
Loading

0 commit comments

Comments
 (0)