Skip to content

Commit c3c7410

Browse files
Blog submission for OBF
Added a blog submission template for OBF events.
1 parent 372233d commit c3c7410

File tree

1 file changed

+174
-0
lines changed

1 file changed

+174
-0
lines changed
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,175 @@
1+
---
2+
author: "Your name as you'd like it to be shown on the website"
3+
date: 2025-05-20 # format is YYYY-MM-DD
4+
draft: true
5+
category:
6+
- community
7+
- event-fellowship
8+
- travel-fellowship
9+
cover:
10+
image: /wp-content/uploads/YYYY/YYYY-MM-DD-cover-image-name.png
11+
alt: "Image description for accessibility"
112

13+
tag:
14+
- community
15+
- event-fellowship
16+
- travel-fellowship
17+
18+
title: "Title of Your Blogpost"
19+
url: /YYYY/MM/DD/YYYY-MM-DD-your-name-blog-title/
20+
---
21+
22+
---
23+
Welcome to the OBF Blog Submission Template!
24+
25+
📌 PLEASE READ CAREFULLY:
26+
Do NOT edit this template file directly. Instead, follow the steps below to submit your blog post.
27+
28+
---
29+
30+
## How to Submit Your Blog Post
31+
32+
### 1. Create a GitHub Account (if needed)
33+
34+
If you don’t have a GitHub account, create one at https://github.com/signup
35+
36+
---
37+
38+
### 2. Fork the OBF Website Repository
39+
40+
Go to the OBF website repository:
41+
https://github.com/OBF/OBF.github.io
42+
43+
Click the **"Fork"** button (top right) to create a copy under your GitHub account.
44+
45+
---
46+
47+
### 3. Create a New Blog Post Markdown File
48+
49+
In your forked repository:
50+
51+
1. Navigate to `content/posts/`
52+
2. Click **"Add file" → "Create new file"**
53+
3. Name your file based on the date using the format:
54+
`YYYY-MM-DD-your-name-blog-title.md`
55+
_Example:_ `2025-04-29-your-name-nfcore-nextflow-hackathon.md`
56+
57+
4. View template raw, and Copy and paste all the contents of this template into the new file.
58+
5. Replace the placeholder text (date, title, author, content, image name, etc.) with your actual blog content.
59+
60+
---
61+
62+
### 4. Upload Your Images
63+
64+
1. Navigate to the folder: `static/img/YYYY/` for the current year
65+
2. Click **"Add file" → "Upload files"**
66+
3. Upload your image(s) here using the format YYYY-MM-DD-image-name.jpg
67+
68+
To insert images in your blog post, use the following format (without the static prefix):
69+
70+
```markdown
71+
![Your image caption](/img/YYYY/YYYY-MM-DD-image-name.jpg)
72+
```
73+
74+
---
75+
76+
### 5. Submit a Pull Request (PR)
77+
78+
Once your edits are complete:
79+
80+
1. Go to your fork’s main page on GitHub
81+
2. Click **"Contribute" → "Open pull request"**
82+
3. Make sure it targets the `main` branch of
83+
https://github.com/OBF/OBF.github.io
84+
4. Use the title: `New blog post: [your title] by [your name]`
85+
5. Click **"Create pull request"**
86+
87+
We will review your post, help with final edits, and publish it for you.
88+
89+
---
90+
91+
92+
## Paste the Reviewed Content below and use the instructions to add images, URLs, etc
93+
94+
Delete the instructions above once you are ready to submit your blog post. Feel free to structure your content as you like, but here are some suggestions to get you started.
95+
96+
97+
# Your Blog Post (do not inlude this line or repeat the title here)
98+
99+
**_The_** [**_Open Bioinformatics Foundation (OBF) Event Fellowship program_**](/travel-awards) **_aims to promote diverse participation at events promoting open-source bioinformatics software development and open science practices in the biological research community. [FULL NAME],_** _**a [YOUR POSITION, e.g., MSc/PhD researcher] at**_ _**[YOUR INSTITUTION]**_, **_was awarded an OBF Event Fellowship to attend_** _**the**_ **_[EVENT NAME](EVENT URL)_**.
100+
101+
102+
103+
## Introduction
104+
105+
Write an engaging intro! What was the event? Where did you go? Why was it exciting?
106+
107+
## Background or Context
108+
109+
What motivated you to apply or attend? How does this relate to your work or goals?
110+
111+
## Key Highlights
112+
113+
Describe the sessions, people, activities, or discoveries that stood out, emphasising how they relate to open science in bioinformatics.
114+
115+
- You can use bullet points
116+
- Or numbered lists
117+
- Or paragraphs with images and links
118+
119+
(Keep this section brief! You're not writing a grant proposal!)
120+
121+
### Add Images
122+
123+
Upload your images to `static/img/YYYY/` for the current year.
124+
Then use the following without the static prefix:
125+
126+
```markdown
127+
![Alt text](/img/YYYY/YYYY-MM-DD-image-name.jpg)
128+
```
129+
#### Add an image to your first paragraph
130+
131+
Due to a quirk in the way our web templating system is set up, you need to include an image in the opening paragraph in order to have it show up on the [Posts page](https://www.open-bio.org/blog/).
132+
You can put a good image (ideally, one that shows you at the conference, and is more wide than tall) at the end of the canned text about the OBF Event Fellowship,
133+
on the next line but with no blank line in between.
134+
See, for example, https://github.com/OBF/OBF.github.io/blob/main/content/posts/2025-08-25-Tayyaba-Alvi-ISMB2025.md.
135+
136+
### Add Links
137+
138+
```markdown
139+
[Link text](https://example.com)
140+
```
141+
142+
Example: [OBF Event Fellowship](https://www.open-bio.org/event-awards/)
143+
144+
### Add Code Blocks
145+
146+
There's probably no need to add code blocks to a blog post, but if you do, use fenced blocks:
147+
148+
\`\`\`bash
149+
nextflow run awesome-workflow.nf
150+
\`\`\`
151+
152+
### Add Videos
153+
154+
You can embed a video with a simple link or screenshot and description.
155+
156+
Example:
157+
158+
[Watch on YouTube](https://www.youtube.com/watch?v=ju_-yUELgAc)
159+
160+
---
161+
162+
## Reflections
163+
164+
What did you learn? Who did you connect with? How will you promote open science in Bioinformatics?
165+
166+
---
167+
168+
## Acknowledgements
169+
170+
Thank your funders, mentors, collaborators, or community members.
171+
172+
---
173+
174+
Ready to Submit?
175+
Follow the pull request steps above under “

0 commit comments

Comments
 (0)