Skip to content

Commit 8f5887f

Browse files
emsimonsPseudomanifold
authored andcommitted
wiki article for updating projects on overview page
1 parent 4fda3ea commit 8f5887f

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Updating projects on the homepage figure
3+
---
4+
As the lab engages in new projects, the website should be updated to reflect these exciting new endeavors.
5+
6+
This wiki article explains how to update one of the hexagonal icons on the homepage (see [Welcome](/Welcome)).
7+
8+
### Step 1: Design a new hexagon overview figure using Figma
9+
10+
You will need access to the AIDOS lab's shared Figma project. (Reach out to a team member if you require access). Within the project, there is a page entitled `Project Overview Figure`.
11+
12+
Here you will find the template for a new project icon, shown below.
13+
14+
<img src="/wiki/project-template.svg" alt="Project icon template" style="width: 25%; height: auto;">
15+
16+
Duplicate the template, fill in the project name, and add your favorite figure.
17+
18+
Once you are content with the project icon, select it and use the control panel on the right export it as an SVG file.
19+
20+
<img src="/wiki/exporting-svg.png" alt="Project icon template" style="width: 50%; height: auto;">
21+
22+
For consistency, please name the file `project_title.svg`.
23+
24+
### Step 2: Update the Repo
25+
26+
#### Important! Remember to make a branch and open a pull request! All the following changes should be made on a separate branch.
27+
28+
Upload your image (saved as `project_title.svg`) to the repo under the `/static/project-images` folder.
29+
30+
In the `/layouts/shortcodes/projects.html` file, you will see the HTML code that controls which project images are shown.
31+
32+
Find the `project-column` div with the project you want to replace. It will look something like so:
33+
34+
```html
35+
<div class="project-column">
36+
<a href="https://arxiv.org/abs/######">
37+
<img src="project-images/project-name.svg"
38+
alt="Project name here">
39+
</a>
40+
</div>
41+
```
42+
43+
Make sure you:
44+
1. Edit the arXiv link.
45+
2. Change `project-name.svg` in to the name of your new image.
46+
3. Change the alt text to reflect your project title.
47+
48+
### Step 3: Final Check & PR Submission
49+
50+
After a quick check to make sure the image is rendering properly, you are ready to submit the pull request for Bastian to review.
51+
52+
Nice work!

0 commit comments

Comments
 (0)