Improve sub-org contact visibility for GSoC students #398
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| {% comment %} | ||
| This include displays contact information for a specific sub-organisation. | ||
| Usage: {% include suborg_contacts.html suborg="sunpy" %} | ||
| {% endcomment %} | ||
|
|
||
| {% assign suborg_name = include.suborg | downcase %} | ||
| {% assign suborg_data = site.data.members[suborg_name] %} | ||
|
|
||
| {% if suborg_data %} | ||
| <div class="suborg-contact-info" style="background-color: #f5f5f5; padding: 15px; margin: 20px 0; border-left: 4px solid #2196F3;"> | ||
| <h4 style="margin-top: 0;">📬 Contact {{ suborg_data.name }}</h4> | ||
| <p>Interested in this project? Get in touch with the {{ suborg_data.name }} community:</p> | ||
| <ul style="margin-bottom: 0;"> | ||
| {% if suborg_data.chat %} | ||
| {% if suborg_data.chat.matrix %} | ||
| <li><strong>Chat (Matrix):</strong> <a href="{{ suborg_data.chat.matrix }}" target="_blank">Join Matrix channel</a></li> | ||
| {% endif %} | ||
| {% if suborg_data.chat.slack %} | ||
| <li><strong>Chat (Slack):</strong> <a href="{{ suborg_data.chat.slack }}" target="_blank">Join Slack workspace</a></li> | ||
| {% endif %} | ||
| {% if suborg_data.chat.gitter %} | ||
| <li><strong>Chat (Gitter):</strong> <a href="{{ suborg_data.chat.gitter }}" target="_blank">Join Gitter channel</a></li> | ||
| {% endif %} | ||
| {% if suborg_data.chat.zulip %} | ||
| <li><strong>Chat (Zulip):</strong> <a href="{{ suborg_data.chat.zulip }}" target="_blank">Join Zulip channel</a></li> | ||
| {% endif %} | ||
| {% if suborg_data.chat.irc %} | ||
| <li><strong>Chat (IRC):</strong> <a href="{{ suborg_data.chat.irc }}" target="_blank">Join IRC channel</a></li> | ||
| {% endif %} | ||
| {% endif %} | ||
| {% if suborg_data.mailinglist %} | ||
| {% if suborg_data.mailinglist.users %} | ||
| <li><strong>User mailing list:</strong> <a href="{{ suborg_data.mailinglist.users }}" target="_blank">Subscribe here</a></li> | ||
| {% endif %} | ||
| {% if suborg_data.mailinglist.devs %} | ||
| <li><strong>Developer mailing list:</strong> <a href="{{ suborg_data.mailinglist.devs }}" target="_blank">Subscribe here</a></li> | ||
| {% endif %} | ||
| {% if suborg_data.mailinglist.admin %} | ||
| <li><strong>Contact admin:</strong> <a href="{{ suborg_data.mailinglist.admin }}" target="_blank">Email admin</a></li> | ||
| {% endif %} | ||
| {% endif %} | ||
| {% if suborg_data.url %} | ||
| <li><strong>Website:</strong> <a href="{{ suborg_data.url }}" target="_blank">{{ suborg_data.url }}</a></li> | ||
| {% endif %} | ||
| </ul> | ||
| <p style="margin-top: 10px; margin-bottom: 0; font-size: 0.9em; color: #666;"> | ||
| <em>Remember: Contact mentors in public channels rather than via direct messages or email.</em> | ||
| </p> | ||
| </div> | ||
| {% else %} | ||
| <div class="suborg-contact-info" style="background-color: #fff3cd; padding: 15px; margin: 20px 0; border-left: 4px solid #ffc107;"> | ||
| <p><strong>Note:</strong> For contact information about this project, please refer to the <a href="/gsoc/student_guidelines.html#sub-organisation-contact-information">Student Guidelines</a>.</p> | ||
| </div> | ||
| {% endif %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,84 @@ | ||
| # Project Ideas | ||
|
|
||
| This directory contains project ideas for OpenAstronomy's participation in programs like Google Summer of Code (GSoC). | ||
|
|
||
| ## Directory Structure | ||
|
|
||
| Projects are organized by year and sub-organisation: | ||
| ``` | ||
| _projects/ | ||
| ├── YYYY/ | ||
| │ ├── suborg1/ | ||
| │ │ ├── project1.md | ||
| │ │ └── project2.md | ||
| │ └── suborg2/ | ||
| │ └── project3.md | ||
| └── _template.md | ||
| ``` | ||
|
|
||
| ## Creating a New Project Idea | ||
|
|
||
| 1. Copy `_template.md` to the appropriate year and sub-organisation directory | ||
| 2. Fill in all the required fields in the YAML front matter | ||
| 3. Write a clear description of the project | ||
| 4. **Add contact information** for your sub-organisation (see below) | ||
| 5. Define clear milestones for the project timeline | ||
| 6. Submit a pull request | ||
|
|
||
| ## Adding Sub-Organisation Contact Information | ||
|
|
||
| To help students reach your community, add contact information to your project page by including this line right after the project title: | ||
|
|
||
| ```liquid | ||
| {% include suborg_contacts.html suborg="yoursuborg" %} | ||
| ``` | ||
|
|
||
| Replace `yoursuborg` with your sub-organisation's key from `_data/members.yaml` (e.g., `sunpy`, `astropy`, `radis`, `stingray`). | ||
|
|
||
| This will automatically display: | ||
| - Chat channels (Matrix, Slack, Gitter, etc.) | ||
| - Mailing lists (users, developers) | ||
| - Website link | ||
| - A reminder to contact mentors in public channels | ||
|
|
||
| ### Example | ||
|
|
||
| ```markdown | ||
| --- | ||
| name: My Awesome Project | ||
| collaborating_projects: | ||
| - sunpy | ||
| --- | ||
|
|
||
| # My Awesome Project | ||
|
|
||
| {% include suborg_contacts.html suborg="sunpy" %} | ||
|
|
||
| ## Description | ||
| ... | ||
| ``` | ||
|
|
||
| ## Updating Contact Information | ||
|
|
||
| Contact information is centrally managed in `_data/members.yaml`. To update your sub-organisation's contact details: | ||
|
|
||
| 1. Edit `_data/members.yaml` | ||
| 2. Update the relevant fields under your sub-organisation's entry | ||
| 3. The changes will automatically appear on all project pages using the include | ||
|
|
||
| ## Template Fields | ||
|
|
||
| See `_template.md` for all available fields and their descriptions. Key fields include: | ||
|
|
||
| - `name`: Project title | ||
| - `desc`: One-line description | ||
| - `requirements`: Student prerequisites | ||
| - `difficulty`: low, medium, or high | ||
| - `mentors`: GitHub/GitLab handles | ||
| - `collaborating_projects`: Sub-organisation(s) | ||
| - `project_size`: Expected time commitment | ||
| - `tags`: Technologies involved | ||
|
|
||
| ## Questions? | ||
|
|
||
| For questions about creating project ideas, contact the OpenAstronomy admins or refer to the [Sub-Org Guidelines](/gsoc/suborg_guidelines.html). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why was this title changed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original README was just a placeholder. I added this as a proper guide for sub org admins on creating project ideas and using the new contact widget. I named it “Project Ideas” to keep it simple and aligned with the folder name.
If you want something more descriptive like “Project Ideas Guide” or “How to Create Project Ideas,” I can change it.
Or should it be like before lemme know.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does "project ideas" convey the purpose of the readme?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i thought it was much more convient but i can change it back if you want it to be like before