Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add community content resource page #5661

Merged
merged 24 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
ab9afa0
add community content page
nomadscientist Dec 19, 2024
8a46c90
add the rest of the resources, off the top of my head
nomadscientist Dec 19, 2024
79525ee
add blog post
nomadscientist Dec 19, 2024
dcd928c
link tutorial
nomadscientist Dec 19, 2024
1f5bdc3
added FAQ on finding pages
nomadscientist Dec 19, 2024
ef59515
Merge branch 'main' into comm_page
nomadscientist Dec 19, 2024
3ae3f4c
Update news/_posts/2024-12-19-community_page.md
nomadscientist Dec 19, 2024
0e1b9d4
Update topics/community/tutorials/community_content/tutorial.md
nomadscientist Dec 19, 2024
4035c92
fix subtopic label
nomadscientist Dec 19, 2024
1944cd5
Merge branch 'comm_page' of https://github.com/nomadscientist/trainin…
nomadscientist Dec 19, 2024
247dbf0
Merge branch 'main' into comm_page
nomadscientist Dec 19, 2024
811d0ee
Update topics/community/tutorials/community_content/tutorial.md
shiltemann Dec 19, 2024
dbd403e
change Page to Home
nomadscientist Dec 19, 2024
9332617
Merge branch 'comm_page' of https://github.com/nomadscientist/trainin…
nomadscientist Dec 19, 2024
f7436a5
Add FAQ on calendar addition
nomadscientist Dec 19, 2024
8f156a4
add calendar FAQ link
nomadscientist Dec 19, 2024
d02c183
Merge branch 'main' into comm_page
nomadscientist Dec 19, 2024
be2446a
Update topics/community/faqs/topic_pages.md
nomadscientist Dec 19, 2024
d6c9f84
fix indent errors?
shiltemann Dec 19, 2024
b555406
Update topics/community/faqs/topic_pages.md
shiltemann Dec 19, 2024
a349413
Update topics/community/faqs/topic_pages.md
shiltemann Dec 19, 2024
89765b5
tweak faqs, iframes
shiltemann Dec 20, 2024
f9b6b09
typo
shiltemann Dec 20, 2024
05101ab
add id to section
shiltemann Dec 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _layouts/topic-maintainer.html
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ <h2>Events using materials from this Topic</h2>
TODO once this is merged:
https://github.com/galaxyproject/training-material/pull/4963

<h2>Statistics For Your Materials</h2>
<h2 id="statistics-for-your-materials">Statistics For Your Materials</h2>

<iframe plausible-embed src="https://plausible.galaxyproject.eu/training.galaxyproject.org?page=%7E%2Ftopics%2F{{ topic.name }}%2F&embed=true&theme=system&background=transparent" scrolling="no" frameborder="0" loading="lazy" style="width: 1px; min-width: 100%; height: 1800px;"></iframe>
<div style="font-size: 14px; padding-bottom: 14px;">Stats powered by <a target="_blank" style="color: #4F46E5; text-decoration: underline;" href="https://plausible.io">Plausible Analytics</a></div>
Expand Down
41 changes: 41 additions & 0 deletions news/_posts/2024-12-19-community_page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "GTN's Gift for 2024"
contributions:
authorship:
- nomadscientist
- hexylena
tags: [gtn, single-cell, new feature, new tutorial, contributing, community]
layout: news
cover: "news/images/spoc_images/community_page.png"
coveralt: "four graphs showing increases over time: training materials including slides and tutorials; contributors; workflows; and other"
---

# Community Pages

# 🎉 Ring in 2025 with the GTN’s Amazing New Feature! 🎉

We’re absolutely *thrilled* to introduce the fabulous **Community Page**—a glorious new addition that has us cheering! 🎊

Here’s why we’re so excited: this page **automatically** tracks and celebrates all the incredible resource contributions from our community over time. 🚀 Whether it’s new workflows, fresh training materials, or awesome contributors, everything is summed up for you, hassle-free!

Gone are the days of frantically piecing together achievements to impress institutes or grant bodies. No more scratching your head at year’s end wondering, *“Wait... what *did* we accomplish?”* GTN gets it. 💡 We know trainers are superheroes juggling this alongside their full-time research or infrastructure roles.

Now, with sleek live charts, we can *see* how our community shines 🌟—in real time! It’s a joyful reflection of all the hard work, dedication, and collaboration that make this community so special.

So here’s a huge **THANK YOU** to the GTN team for this spectacular gift! 🥳 You’ve truly embodied the spirit of user-centered design—not just for the scientists using Galaxy, but for those of us building it, too. 💖

Here’s to an exciting 2024 full of growth, achievements, and community magic! 🎆

#GratefulForGTN

You can find this and other useful features in a [new tutorial collecting community resources]( {% link topics/community/tutorials/community_content/tutorial.md %} ).

Finally, you can see an example from the Single-cell topic below:

<iframe
src="https://training.galaxyproject.org/training-material/topics/single-cell/community.html"
width="100%"
height="800"
style="border: none;"
title="Single-Cell Topic Community Page">
</iframe>
Binary file added news/images/spoc_images/community_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions topics/community/faqs/community_activites_calendar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: How can I add my SIG meetings to the Galaxy Community Activities calendar?
box_type: tip
layout: faq
contributors: [nomadscientist]
---

Add the following guest to all of your Google Calendar meeting events: 8a762890fbe724e9d29b67915aa0197a352642f94b22ec64a85430daaf1abb5e@group.calendar.google.com

Then it will show up in the **Galaxy Community Activities** calendar!

<iframe src="https://calendar.google.com/calendar/embed?height=600&wkst=1&ctz=Europe%2FLondon&showPrint=0&showCalendars=0&mode=AGENDA&src=OGE3NjI4OTBmYmU3MjRlOWQyOWI2NzkxNWFhMDE5N2EzNTI2NDJmOTRiMjJlYzY0YTg1NDMwZGFhZjFhYmI1ZUBncm91cC5jYWxlbmRhci5nb29nbGUuY29t&color=%234285F4" style="border-width:0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
21 changes: 21 additions & 0 deletions topics/community/faqs/community_home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: How do I find the Community Home pages?
box_type: tip
layout: faq
contributors: [nomadscientist, hexylena, shiltemann]
---

The **Community Home** shows statistics for the topic (e.g. number of tutorials, slides, events, contributors, etc),
as well as annual "Year in review" sections listing all new additions to the topic/community for each year.

You can find your **Community Home** by
1. Opening the GTN **Topic** page of your choice
2. Scrolling down to the **Community Resources** section (below the list of tutorials)
3. Clicking the **Community Home** button

![screenshot of the community and maintainer homepage buttons]({% link topics/community/images/community_maintainer_home_buttons.png %})

For example, have a look at the [Single Cell Community Home]({% link topics/single-cell/community.md %})

![screenshot of the single cell community home page]({% link topics/community/images/community_home.png %})

20 changes: 20 additions & 0 deletions topics/community/faqs/maintainer_home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: How do I find the Maintainer Home pages?
box_type: tip
layout: faq
contributors: [nomadscientist, hexylena, shiltemann]
---

The **Maintainer Home** pages shows the state of the topic and its materials in terms of which available GTN features are being used, adherence to best practices, and when tutorials have last been updated, and which tutorials are the most used, etc. This can help inform where to focus your efforts.

You can find your **Maintainer Home** by
1. Opening the GTN **Topic** page of your choice
2. Scrolling down to the **Community Resources** section (below the list of tutorials)
3. Clicking the **Maintainer Home** button

![screenshot of the community and maintainer homepage buttons]({% link topics/community/images/community_maintainer_home_buttons.png %})

For example, have a look at the [Single Cell Maintainer Home]({% link topics/single-cell/maintainer.md %})

![screenshot of the single cell maintainer home page]({% link topics/community/images/maintainer_home.png %})

Binary file added topics/community/images/community_home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added topics/community/images/maintainer_home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions topics/community/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,13 @@ summary: |
#docker_image: "quay.io/galaxy/community"
learning_path_cta: dev_tools_training

subtopics:
- id: sig
title: "Special Interest Groups & Communities"
description: "These tutorials will get you started with the basics of what a special interest group is and how to build one."
- id: subdomain
title: "Subdomains & Galaxy Labs"
description: "This tutorial will guide you on how to build subdomains / Galaxy Labs"

editorial_board:
- nomadscientist
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Creation of an interactive Galaxy tools table for your community
level: Introductory
redirect_from:
- /topics/dev/tutorials/community-tool-table/tutorial
subtopic: sig
nomadscientist marked this conversation as resolved.
Show resolved Hide resolved

questions:
- Is it possible to have an overview of all Galaxy tools for a specific scientific domain?
Expand Down
3 changes: 3 additions & 0 deletions topics/community/tutorials/community_content/faqs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
layout: faq-page
---
165 changes: 165 additions & 0 deletions topics/community/tutorials/community_content/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
---
layout: tutorial_hands_on
priority: 1
subtopic: sig
title: "Creating community content"
questions:
- "What content does my Topic automatically get from the GTN?"
- "How can I make sure this data is collected well?"
objectives:
- "Signpost community leads and users to useful resources"
- "Explain why metadata is key for such community resources"
- "Provide a reference, rather than a tutorial"
time_estimation: "30M"
key_points:
- "The GTN has worked hard to provide automated metrics and resources to highlight and acknowledge the efforts of communities and community leads"
- "This only works if we contribute with effective tagging."
nomadscientist marked this conversation as resolved.
Show resolved Hide resolved
requirements:
contributions:
authorship:
- nomadscientist
requirements:
-
type: "internal"
topic_name: community
tutorials:
- sig_define
---

Galaxy *[Special Interest Group](https://galaxyproject.org/community/sig)* (**SIG**)s work hard to build and maintain training resources. The GTN has worked hard to acknowledge this and offer nice impact pages to communities.

Here is a list of resources that you can use!

> <comment-title></comment-title>
> - We want this material to grow (similar to the 'Creating content in markdown' tutorial) so please do add further resources that can help communities!
{: .comment}

> <agenda-title></agenda-title>
>
> In this tutorial, we will cover:
>
> 1. TOC
> {:toc}
>
{: .agenda}

# Maintainer Home

Maintaining resources is **fundamental** to the quality and usefulness of any software resource. We do *not* throw code over the wall!

To help topic maintainers to quickly recognise what materials need updating and fixing, topic **Maintainer Homes** were built.

> <hands-on-title>Go to your topic Maintainer Home</hands-on-title>
>
> 1. Go to any GTN training topic of interest.
> 2. Scroll down past the tutorials, and click on the "Maintainer Home" button
>
> {% snippet topics/community/faqs/maintainer_home.md %}
>
> 3. Explore the Maintainer Home!
> - For example, the [Single Cell Maintainer Home]({% link topics/single-cell/maintainer.md %})
>
{: .hands_on}

You may instantly see some key information missing from tutorials, or how long its been since someone checked it! Time to update some materials!

You can see an example from the Single-cell topic below:

<iframe
src="/training-material/topics/single-cell/maintainer.html"
width="100%"
height="800"
style="border: none;"
title="Single-Cell Topic Maintainer Home">
</iframe>

# Community Home

Where the **Maintainer Home** helps you sustain your community, the **Community Home** helps you show off your community. An end-of-year gift in 2024, this page will sift through news, events, and GTN contributions for your community tag of interest (example: single-cell) and provide a beautiful visualization of your efforts.

> <hands-on-title>Go to your topic Community Home</hands-on-title>
>
> 1. Go to any GTN training topic of interest.
> 2. Scroll down past the tutorials, and click on the "Community Home" button
>
> {% snippet topics/community/faqs/community_home.md %}
>
> 3. Explore the Community Home!
> - For example, the [Single Cell Community Home]({% link topics/single-cell/community.md %})
>
{: .hands_on}

You can see an example from the Single-cell topic below:

<iframe
src="/training-material/topics/single-cell/community.html"
width="100%"
height="800"
style="border: none;"
title="Single-Cell Topic Community Home">
</iframe>

# Topic usage statistics

Next up, you might want to know how many people are actually using your materials? Welcome to your **Topic usage statistics**! You may have already found this, actually, as it's (currently) at the bottom of the Maintainer Home.

> <hands-on-title>Go to your topic usage statistics</hands-on-title>
>
> 1. Go to any GTN training topic of interest.
> 2. Scroll down past the tutorials, and click on the "Maintainer Home" button
>
> {% snippet topics/community/faqs/maintainer_home.md %}
>
> 3. Scroll down to the section "Statistics For Your Materials"
> 4. Explore the usage statistics!
> - For example, the [Single Cell Usage Statistics]({% link topics/single-cell/maintainer.md %}#statistics-for-your-materials)
>
{: .hands_on}

You can see an example from the Single-cell topic below.

<iframe
src="/training-material/topics/single-cell/maintainer.html#statistics-for-your-materials"
width="100%"
height="800"
style="border: none;"
title="Single-Cell Topic Usage Statistics">
</iframe>

# News widgets

You can also embed news into your pages, subdomains/ Galaxy Labs, or even your Matrix channels.

Follow this documentation to learn how:

1. [GTN Feeds]( {% link feeds/index.md %} )
2. [Bot integration into matrix]( {% link news/2023/12/20/matrix-bots.md %} )

You can see an example from the Single-cell topic below.

<h3 class="mb-3">News and Events</h3>
<iframe width="100%" height="600px" src="/training-material/feeds/single-cell-month.w.html"></iframe>

# Workflow search

Want to see all the workflows tagged with your community tag across public servers? Look no further!

Follow this documentation to learn how:

1. [Galaxy Pan-Galactic Workflow Search]( {% link workflows/list.md %} )
2. [Workflow Search Querying]( {% link news/2023/11/20/workflow-search.md %} )

You can see an example from the Single-cell topic below.

<h3 class="mb-3">Public workflows</h3>
<iframe src="/training-material/workflows/embed.html?query=single-cell" height="600px" width="100%" class="gtn-embed" frameborder="1"></iframe>

# Galaxy Community Activities calendar

We host a GoogleCalendar on the [Galaxy Special Interest Group Hub page](https://galaxyproject.org/community/sig/).

{% snippet topics/community/faqs/community_activites_calendar.md %}

# Conclusion

{% icon congratulations %} Congratulations! You've made it to the end! Hopefully you think these resources are brilliant, and are making sure to tag everything (news, events, training materials, workflows, FAQs, you name it, you should tag it!) with your community tag!
1 change: 1 addition & 0 deletions topics/community/tutorials/sig_create/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: tutorial_hands_on
priority: 2
subtopic: sig

title: "Creating a Special Interest Group"
questions:
Expand Down
1 change: 1 addition & 0 deletions topics/community/tutorials/sig_define/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: tutorial_hands_on
priority: 1
title: "What's a Special Interest Group?"
subtopic: sig
questions:
- "What is a Special Interest Group?"
- "What is the purpose of a Special Interest Group?"
Expand Down
9 changes: 5 additions & 4 deletions topics/community/tutorials/tools_subdomains/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: tutorial_hands_on

title: Make your tools available on your subdomain
subtopic: subdomain
questions:
- How can a tool be added in a section ?
- How can a section be added in a subdomain ?
Expand Down Expand Up @@ -43,15 +44,15 @@ This tutorial explains how to make your brand new tools, once they're published
> - For Galaxy Europe, fork the [usegalaxy-eu-tools repo](https://github.com/usegalaxy-eu/usegalaxy-eu-tools)
> - Create a branch on your fork
> - Browse through the different yaml files and select the one that correspond to your subdomain for earth system everything is made under the ecology owner. The name of the files corresponds to a toolshed owner or community and a few of those communities with a review system and CI integration gets special trust and auto-updates.
> - Once in the yaml you can add the section for your tool (you want to know what are the existing tool sections ? Go check the [categories defined here](https://github.com/usegalaxy-eu/infrastructure-playbook/blob/master/templates/galaxy/config/tool_conf.xml.j2))
>
> - Once in the yaml you can add the section for your tool (you want to know what are the existing tool sections ? Go check the [categories defined here](https://github.com/usegalaxy-eu/infrastructure-playbook/blob/master/templates/galaxy/config/tool_conf.xml.j2))
>
> An example on how to fill in the yaml file
> ```
> - name: id_of_your_tool
> owner: choose_the_owner_relative_to_a_github_repo
> tool_panel_section_label: 'Choose the section where your tool belongs'
> ```
>
>
> ![Image of the modification to make in the ecology.yaml file](../../images/tool_subdomain/ecology_yml_tool.png)
>
> - Then commit your changes and write a nice message for the admin when you open your Pull Request.
Expand Down Expand Up @@ -85,7 +86,7 @@ This part is only to make batch tool visible in your subdomain.
> - Then, commit your changes and write a nice message for the admin when you open your Pull Request.
{: .hands_on}

If you choose to create a new section for your interactive tool don't forget add this section to your subdomain !
If you choose to create a new section for your interactive tool don't forget add this section to your subdomain !

# Conclusion

Expand Down
Loading