Skip to content

Commit 6e0831c

Browse files
sa-fw-ansa-fw-an
committed
Revert "Updating the style to write Blogs/Update Blog Template for GSoC_DMP_SSoC"
This reverts commit b9a5f7b.
1 parent 1e73254 commit 6e0831c

File tree

2 files changed

+40
-64
lines changed

2 files changed

+40
-64
lines changed

‎docs/GSoC-Blogpost-Guidelines.md‎

Lines changed: 31 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,23 @@
1-
# GSoC '25 Blogpost Guidelines
1+
# GSoC ’25 Blogpost Guidelines
22

3-
This document explains how to write and format your weekly GSoC '25 updates for the Sugar Labs website. Follow these instructions to ensure consistency and clarity across all posts.
3+
This document explains how to write and format your weekly GSoC ’25 updates for the Sugar Labs website. Follow these instructions to ensure consistency and clarity across all posts.
44

55
<!-- markdownlint-disable -->
66

7-
## Step 1: Create Your Author Profile (One-time setup)
7+
## 1. Official Template
88

9-
Before writing your first blog post, you need to create an author profile that will be linked to all your posts.
10-
11-
1. **Create a new file** in `constants/MarkdownFiles/authors/` named `your-username.md`
12-
2. **Use this template** and replace the placeholder information:
13-
14-
```markdown
15-
---
16-
name: "Your Full Name"
17-
slug: "your-username"
18-
title: "GSoC'25 Contributor"
19-
organization: "SugarLabs"
20-
description: "GSoC'25 Contributor at SugarLabs"
21-
avatar: "https://avatars.githubusercontent.com/u/YOUR_GITHUB_ID?s=400"
22-
---
23-
24-
<!--markdownlint-disable-->
25-
26-
# About [Your Name]
27-
28-
Write something about yourself
29-
30-
## Experience
31-
32-
Write some experience or other categories that you want to add
33-
34-
## Current Projects
35-
36-
Your Projects or other sections
37-
38-
## Connect with Me
39-
40-
- **GitHub**: [@your-username](https://github.com/your-username)
41-
- **Email**: [[email protected]](mailto:[email protected])
42-
- **LinkedIn**: [Your Name](https://linkedin.com/in/your-profile)
43-
- **Twitter**: [@your_handle](https://twitter.com/your_handle)
44-
- **Website**: [yourwebsite.com](https://yourwebsite.com) *(optional)*
45-
- **Discord**: [your#1234](https://discord.com/users/your#1234) *(optional)*
46-
```
47-
48-
## Step 2: Official GSoC Blog Post Template
49-
50-
Use the exact template below for every GSoC '25 week update. You can also find this under `constants/MarkdownFiles/posts/YYYY-MM-DD-GSoC_DMP_SSoC_Template.md`. Copy it into `constants/MarkdownFiles/posts/YYYY-MM-DD-gsoc-25-username-weekXX.md`, then fill in your details.
9+
Use the exact template below for every GSoC ’25 week update or you will also find this under `constants/MarkdownFiles/posts/GSoC_Template.md`. Copy it into `constants/MarkdownFiles/posts/gsoc-25-username-weekXX.md`, then fill in your details.
5110

5211
```markdown
5312
---
54-
title: "GSoC '25 Week XX Update by [Your Name]"
55-
excerpt: "Brief description of this week's progress"
56-
category: "DEVELOPER NEWS"
57-
date: "2025-06-14"
58-
slug: ""YYYY-MM-DD-gsoc-25-username-weekXX""
59-
author: "@/constants/MarkdownFiles/authors/your-username.md"
60-
tags: "gsoc25,sugarlabs,weekXX,username"
13+
title: "GSoC ’25 Week XX Update by Safwan Sayeed"
14+
excerpt: "This is a Template to write Blog Posts for weekly updates"
15+
category: "TEMPLATE"
16+
date: "2025-05-10"
17+
slug: "gsoc-25-sa-fw-an-weekX"
18+
author: "Safwan Sayeed"
19+
description: "Maintainer and GSoC'25 Contributor at SugarLabs"
20+
tags: "gsoc25,sugarlabs,weekXX,sa-fw-an"
6121
image: "assets/Images/GSOC.png"
6222
---
6323

@@ -80,7 +40,7 @@ image: "assets/Images/GSOC.png"
8040

8141
---
8242

83-
## This Week's Achievements
43+
## This Week’s Achievements
8444

8545
1. **[Task or Feature]**
8646
- What you did and why it matters.
@@ -114,7 +74,7 @@ image: "assets/Images/GSOC.png"
11474

11575
---
11676

117-
## Next Week's Roadmap
77+
## Next Week’s Roadmap
11878

11979
- Implement **Feature XYZ** and write corresponding tests.
12080
- Refine **technical design** based on mentor feedback.
@@ -136,31 +96,39 @@ image: "assets/Images/GSOC.png"
13696
Thank you to my mentors, the Sugar Labs community, and fellow GSoC contributors for ongoing support.
13797

13898
---
99+
100+
## Connect with Me
101+
102+
- GitHub: [@sa-fw-an](https://github.com/sa-fw-an)
103+
- Gmail: [[email protected]](mailto:[email protected])
104+
- LinkedIn: [Safwan Sayeed](https://www.linkedin.com/in/safwan-sayeed-6a3a482a9/)
105+
- Twitter: [@safwan_say](https://twitter.com/safwan_say)
106+
107+
---
108+
139109
```
140110

141-
## Updating Your Post
111+
## 2. Updating Your Post
142112

143113
1. Change the frontmatter `category` from `"TEMPLATE"` to `"DEVELOPER NEWS"`.
144114
2. Replace placeholder text:
145115
- **Week XX**, dates, PR/issue numbers, links, screenshot URLs.
146116
- Your project name, mentor usernames, reporting period.
147-
3. Update `title`, `excerpt`, `date`, `slug`, `author`, `tags`, `image`.
148-
4. The `author` field should point to your author file: `"@/constants/MarkdownFiles/authors/your-username.md"`
149-
5. Please keep (`<!-- markdownlint-disable -->`) to disable any markdown linting.
150-
6. Change the contents of the file accordingly.
151-
7. **Remove the "Connect with Me" section** from your blog post - this information is now in your author profile.
117+
3. Update `title`, `excerpt`, `date`, `slug`, `author`, `description`, `tags`, `image`.
118+
4. Please keep (`<!-- markdownlint-disable -->`) to disable any markdown linting.
119+
5. Change the contents of the file accordingly.
152120

153-
## File & PR Workflow
121+
## 3. File & PR Workflow
154122

155123
- Branch off `main` with `gsoc-weekXX-username`.
156124
- Add your file under `constants/MarkdownFiles/posts/`.
157125
- Commit and open a PR titled:
158126
```
159-
GSoC '25 Week XX Update by Name
127+
GSoC ’25 Week XX Update by Name
160128
```
161129
- In PR description, link any issue tracking the weekly report and ping your mentors.
162130
- After review, squash-and-merge.
163131

164132
---
165133

166-
By strictly following this template and these steps, we ensure every GSoC '25 post is uniform and high quality. Happy writing!
134+
By strictly following this template and these steps, we ensure every GSoC ’25 post is uniform and high quality. Happy writing!

‎src/constants/MarkdownFiles/posts/YYYY-MM-DD-GSoC_DMP_SSoC_Template.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "GSoC ’25 Week XX Update by Safwan Sayeed"
33
excerpt: "This is a Template to write Blog Posts for weekly updates"
44
category: "TEMPLATE"
55
date: "2025-05-10"
6-
slug: "YYYY-MM-DD-gsoc-25-sa-fw-an-weekXX"
6+
slug: "gsoc-25-sa-fw-an-weekX"
77
author: "@/constants/MarkdownFiles/authors/safwan-sayeed.md"
88
tags: "gsoc25,sugarlabs,weekXX,sa-fw-an"
99
image: "assets/Images/GSOC.png"
@@ -85,3 +85,11 @@ Thank you to my mentors, the Sugar Labs community, and fellow GSoC contributors
8585

8686
---
8787

88+
## Connect with Me
89+
90+
- GitHub: [@sa-fw-an](https://github.com/sa-fw-an)
91+
- Gmail: [[email protected]](mailto:[email protected])
92+
- LinkedIn: [Safwan Sayeed](https://www.linkedin.com/in/safwan-sayeed-6a3a482a9/)
93+
- Twitter: [@safwan_say](https://twitter.com/safwan_say)
94+
95+
---

0 commit comments

Comments
 (0)