Skip to content

Commit efb7616

Browse files
neural-loopneural-loop
committed
feat: getting-involved: Revamp contribution guide
Adds new contribution guides and a contribution card. Moves old index.md to _index.md.
1 parent 1b52397 commit efb7616

File tree

8 files changed

+212
-12
lines changed

8 files changed

+212
-12
lines changed

‎content/getting-involved/host-an-event/index.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: "Host an Event"
3+
description: "Present your research, lead a workshop, or host a discussion. Learn how to share your expertise with the Open Neuromorphic community through our events."
4+
---
5+
6+
Sharing your knowledge through a live event is a powerful way to engage with the community, get feedback on your work, and help others learn. Open Neuromorphic hosts several types of events, and we are always looking for new speakers and hosts.
7+
8+
### Types of Events You Can Host
9+
10+
- **Workshops:** Lead a hands-on session or a deep-dive presentation on a specific neuromorphic tool, technology, or research area.
11+
- **Student Talks:** Present your ongoing research, a recently published paper, or a comprehensive literature review. This is a great platform for students and early-career researchers.
12+
- **Hacking Hours:** Co-host a live coding session to tackle a specific problem, demonstrate a library, or explore a new concept.
13+
14+
---
15+
16+
### How to Propose an Event
17+
18+
Getting started is easy. You don't need to be a seasoned presenter; you just need a passion for your topic.
19+
20+
1. **Have an Idea:** Think about what you'd like to share. It could be your latest project, a tutorial you've developed, or a topic you're passionate about.
21+
22+
2. **Reach Out to Us:** Contact us through one of these channels:
23+
- **Discord:** This is the best way. Post a message in the `#events` channel on our [Discord server](https://discord.gg/C9bzWgNmqk) or send a direct message to an Executive Committee member (like **Jens E. Pedersen** or **Fabrizio Ottati**).
24+
- **Email:** Send your proposal to **contact@open-neuromorphic.org**.
25+
26+
3. **Tell Us About Your Idea:** In your message, please include:
27+
- A brief title and description of your proposed talk/workshop.
28+
- The type of event you're interested in (Workshop, Student Talk, etc.).
29+
- A short bio of yourself.
30+
31+
---
32+
33+
### What We Provide
34+
35+
Once your event is scheduled, we'll support you by:
36+
- Promoting the event across our website, social media, and Discord community.
37+
- Providing the streaming platform (e.g., YouTube Live).
38+
- Co-hosting the session to manage logistics and Q&A.
39+
- Archiving the recorded video on our website and YouTube channel.

‎content/getting-involved/index.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,24 @@ layout_class=""
3939
explore_links="About ONM & Governance|/about/;Host a Workshop|/workshops/#host-a-workshop;ONM Initiatives|/neuromorphic-computing/initiatives/"
4040
>}}
4141
42-
## Advancing Your Involvement: Initiatives & Fellowship
42+
## Specific Ways to Contribute
4343

44-
Your contributions, big or small, are the lifeblood of Open Neuromorphic. As you engage with our community and projects, you might find yourself wanting to take on more focused roles or lead new efforts. This is where **ONM Initiatives** and **Fellowship** come into play.
44+
Ready to jump in? Here are some of the most impactful ways you can contribute to the community. We've created simple guides for each, with options for all skill levels.
4545

46-
**ONM Initiatives** are community-driven projects and efforts aimed at achieving specific goals that align with our mission. These can range from developing new educational resources, organizing event series, improving our software tools, to spearheading new research collaborations.
47-
* **Discover & Join:** Explore [current ONM Initiatives](/neuromorphic-computing/initiatives/) to see where your skills and passion can make a direct impact.
48-
* **Propose Your Own:** Have an idea that could benefit the neuromorphic community? We encourage you to [propose a new initiative](https://github.com/open-neuromorphic/communications/blob/main/docs/initiatives/submit_initiative_instructions.md)!
46+
<div class="my-16 grid grid-cols-1 gap-8 md:grid-cols-2 lg:grid-cols-3">
47+
{{< contribution_card icon="fas fa-pen-to-square" title="Write for Our Blog" link="/getting-involved/write-a-blog-post/" >}}
48+
Share your research, tutorials, or insights with a global audience. We make it easy to submit your work, even if you're not a GitHub expert.
49+
{{< /contribution_card >}}
4950

50-
**ONM Fellowship** is a way we recognize individuals who demonstrate sustained, impactful contributions and leadership within our community. Actively participating in and leading initiatives is a key pathway to becoming an ONM Fellow.
51-
* **Learn More:** Understand the [Path to Fellowship](https://github.com/open-neuromorphic/communications/blob/main/docs/fellowship/path_to_fellowship.md) and how your continued involvement can lead to this recognition.
51+
{{< contribution_card icon="fas fa-chalkboard-user" title="Host an Event" link="/getting-involved/host-an-event/" >}}
52+
Present a workshop, give a student talk, or co-host a Hacking Hour. It's a great way to share your knowledge and get valuable feedback.
53+
{{< /contribution_card >}}
5254

53-
By engaging in initiatives, you not only help drive the ONM community forward but also develop your own skills, expand your network, and gain valuable experience in the open-source neuromorphic landscape.
55+
{{< contribution_card icon="fas fa-rocket" title="Join an Initiative" link="/getting-involved/join-an-initiative/" >}}
56+
Collaborate on community-driven projects that shape the future of ONM. Explore existing initiatives or propose a new one.
57+
{{< /contribution_card >}}
58+
</div>
5459

55-
Beyond these pathways, there are many specific ways you can contribute to ONM:
60+
Beyond these pathways, a quick and easy way to support our community is by sharing our [website](https://open-neuromorphic.org/) and [Discord](https://discord.gg/C9bzWgNmqk) with your friends and colleagues. We're always looking for new members, and linking to our site helps boost our search engine rankings, making it easier for others to find us.
5661

57-
If you're new to the community, we recommend joining our [Discord](https://discord.gg/C9bzWgNmqk) to connect with other members and learn more about our ongoing projects and initiatives. Leave a message in the `#welcome` channel to introduce yourself and let us know how you'd like to contribute!
58-
59-
One quick and easy way to support our community is by sharing our [website](https://open-neuromorphic.org/) and [Discord](https://discord.gg/C9bzWgNmqk) with your friends and colleagues. We're always looking for new members to join our community. Also, linking to our website helps boost our search engine rankings, which makes it easier for others to find us.
62+
If you're new, we recommend joining our [Discord](https://discord.gg/C9bzWgNmqk) to connect with other members. Leave a message in the `#welcome` channel to introduce yourself!

‎content/getting-involved/join-an-initiative/index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "Join a Community Initiative"
3+
description: "Make a direct impact by joining or leading an Open Neuromorphic initiative. Collaborate on projects that shape the future of our community and the field."
4+
---
5+
6+
Open Neuromorphic thrives on the focused efforts of our community members. **Initiatives** are community-driven projects that tackle specific goals, from developing new resources and tools to organizing event series and improving our digital infrastructure.
7+
8+
Contributing to an initiative is a fantastic way to collaborate with others, gain experience, and make a lasting impact.
9+
10+
### How to Get Involved
11+
12+
#### 1. Explore Existing Initiatives
13+
14+
The best way to start is by seeing what's already in motion. We maintain a directory of all active and past community initiatives.
15+
16+
{{< cta-button text="View All ONM Initiatives" link="/neuromorphic-computing/initiatives/" >}}
17+
18+
Each initiative page lists the goals and the key contributors. To get involved, you can:
19+
- **Join the discussion** on our [Discord server](https://discord.gg/C9bzWgNmqk). Many initiatives have dedicated threads or discussions in relevant channels.
20+
- **Reach out to the initiative lead(s)** to express your interest and see how you can help.
21+
22+
#### 2. Propose a New Initiative
23+
24+
Have an idea that could benefit the neuromorphic community? We strongly encourage members to lead new efforts! Whether it's creating a new tutorial series, benchmarking a new set of tools, or starting a study group, your leadership is welcome.
25+
26+
To propose a new initiative, please follow the instructions on our GitHub repository.
27+
28+
{{< cta-button text="Propose a New Initiative on GitHub" link="https://github.com/open-neuromorphic/communications/blob/main/docs/initiatives/submit_initiative_instructions.md" target="_blank" >}}
29+
30+
This process helps us formalize the initiative and provide the necessary support and visibility.
31+
32+
---
33+
34+
Whether you're joining an existing team or starting something new, your contributions to ONM Initiatives are what drive our community forward.

‎content/getting-involved/write-a-blog-post/index.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "Contribute a Blog Post"
3+
description: "Share your knowledge with the neuromorphic community by writing a blog post for Open Neuromorphic. Learn how you can submit your article."
4+
---
5+
6+
Writing a blog post is one of the best ways to share your expertise, insights, or project updates with the global neuromorphic community. We welcome a variety of topics and are here to help you get your work published on our platform.
7+
8+
### Why Write for ONM?
9+
10+
- **Reach a Global Audience:** Your work will be featured on our platform and promoted across our social channels, reaching thousands of researchers, students, and industry professionals.
11+
- **Build Your Profile:** Establish yourself as a voice in the neuromorphic field.
12+
- **Educate and Inspire:** Help others learn, solve problems, and get excited about the future of brain-inspired computing.
13+
14+
---
15+
16+
### How to Submit Your Post
17+
18+
We offer two straightforward ways to submit your blog post. Choose the one that works best for you.
19+
20+
#### Method 1: The Simple Way (Email or Discord)
21+
22+
This is the easiest way to contribute. You write the content, and we'll handle the rest.
23+
24+
1. **Write your post** in a standard format like Markdown (`.md`), a Google Doc, or a simple text file.
25+
2. **Gather your images** and other assets in a folder.
26+
3. **Send it to us!**
27+
- **Email:** Send your files to **contact@open-neuromorphic.org** with the subject "Blog Post Submission".
28+
- **Discord:** Send a message to **Jens E. Pedersen** or **Justin Riddiough** on our [Discord server](https://discord.gg/C9bzWgNmqk).
29+
30+
We will review your submission, format it for the website, and work with you on any edits before publishing.
31+
32+
#### Method 2: The GitHub Way (Pull Request)
33+
34+
If you're comfortable with Git and GitHub, you can follow our standard contribution process.
35+
36+
1. **Follow the guide** in our [CONTRIBUTING.md](https://github.com/open-neuromorphic/open-neuromorphic.github.io/blob/main/CONTRIBUTING.md#adding-blog-posts) to create a new blog post using the archetype.
37+
2. **Create a new branch** for your post.
38+
3. **Submit a Pull Request** with your completed post. Our team will review it and merge it.
39+
40+
---
41+
42+
### What We're Looking For
43+
44+
We welcome a wide range of topics, including but not limited to:
45+
- Tutorials on neuromorphic software or hardware.
46+
- Summaries and analysis of recent research papers.
47+
- Project updates or case studies.
48+
- Opinion pieces on the future of the field.
49+
- Deep dives into specific neuromorphic concepts.
50+
51+
If you have an idea, don't hesitate to pitch it to us first on Discord or via email!

‎data/used_icons.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ fontawesome_svgs:
1414
- { style: solid, name: code-branch }
1515
- { style: solid, name: arrow-right }
1616
- { style: solid, name: location-dot }
17+
- { style: solid, name: pen-to-square }
1718
- { style: solid, name: envelope }
1819
- { style: solid, name: moon }
1920
- { style: solid, name: sun }

‎layouts/getting-involved/list.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{{ define "main" }}
2+
{{ partial "page-header" . }}
3+
<section class="section pt-7">
4+
<div class="container">
5+
<div class="row justify-center">
6+
<div class="lg:col-10">
7+
<div class="content">
8+
{{ .Content }}
9+
</div>
10+
</div>
11+
</div>
12+
</div>
13+
</section>
14+
{{ end }}

‎layouts/shortcodes/contribution_card.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{{ $icon := .Get "icon" }}
2+
{{ $title := .Get "title" }}
3+
{{ $link := .Get "link" }}
4+
{{ $description := .Inner }}
5+
6+
{{/* Use the same structure and classes as the homepage's involvement-card to ensure consistent styling and solve the link underline issue. */}}
7+
<div class="h-full">
8+
<div class="involvement-card group">
9+
{{ if $icon }}
10+
<div class="involvement-card__icon">
11+
{{ $iconData := partial "helpers/parse-fa-class.html" $icon }}
12+
{{ partial "icon.html" (dict "style" $iconData.style "name" $iconData.name "class" "text-3xl text-white") }}
13+
</div>
14+
{{ end }}
15+
<h3 class="involvement-card__title">
16+
{{ $title }}
17+
</h3>
18+
<div class="involvement-card__description">
19+
{{ $description | markdownify }}
20+
</div>
21+
<span class="involvement-card__cta">
22+
Learn How
23+
{{ partial "icon.html" (dict "style" "solid" "name" "arrow-right" "class" "transform transition-transform duration-200 group-hover:translate-x-1") }}
24+
</span>
25+
26+
{{/* The link is an overlay, so its content is not directly styled as a link */}}
27+
<a href="{{ $link | relLangURL }}" class="absolute inset-0 z-10" aria-label="Learn more about {{ $title }}">
28+
<span class="sr-only">Learn more about {{ $title }}</span>
29+
</a>
30+
</div>
31+
</div>

‎layouts/shortcodes/cta-button.html

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{{/* layouts/shortcodes/cta-button.html */}}
2+
{{- $text := .Get "text" | default "Learn More" -}}
3+
{{- $link := .Get "link" | default "#" -}}
4+
{{- $is_external := strings.HasPrefix $link "http" -}}
5+
6+
{{- /* Determine the target attribute. Default to _blank for external links. */ -}}
7+
{{- $target := "" -}}
8+
{{- if .Get "target" -}}
9+
{{- $target = .Get "target" -}}
10+
{{- else if $is_external -}}
11+
{{- $target = "_blank" -}}
12+
{{- end -}}
13+
14+
{{- /* Determine the final URL. Apply relLangURL only to internal links. */ -}}
15+
{{- $final_link := $link -}}
16+
{{- if not $is_external -}}
17+
{{- $final_link = $link | relLangURL -}}
18+
{{- end -}}
19+
20+
<div class="my-6 text-center">
21+
<a href="{{ $final_link }}"
22+
class="btn btn-new-primary text-lg"
23+
{{ with $target }}target="{{ . }}"{{ end }}
24+
{{ if eq $target "_blank" }}rel="noopener"{{ end }}>
25+
{{ $text | markdownify }}
26+
</a>
27+
</div>

0 commit comments

Comments
 (0)