Skip to content

Commit

Permalink
add community content page
Browse files Browse the repository at this point in the history
  • Loading branch information
nomadscientist committed Dec 19, 2024
1 parent e80ae7f commit ab9afa0
Show file tree
Hide file tree
Showing 7 changed files with 130 additions and 4 deletions.
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: sigs
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

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
---
111 changes: 111 additions & 0 deletions topics/community/tutorials/community_content/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
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: "30"
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."
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 page

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 Pages** were built.

> <hands-on-title>Go to your topic maintainer page</hands-on-title>
>
> 1. Go to any training topic of interest. This will have the form
> ```
> https://training.galaxyproject.org/training-material/topics/<your topic here>
> ```
> 2. Add a /maintainer to the end of the url.
> ```
> https://training.galaxyproject.org/training-material/topics/<your topic here>/maintainer
> ```
> 3. Explore the maintainer page!
>
{: .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="https://training.galaxyproject.org/training-material/topics/single-cell/maintainer.html"
width="100%"
height="800"
style="border: none;"
title="Galaxy Project Single-Cell Maintainer">
</iframe>
# Community Page
Where the **Maintainer page** helps you sustain your community, the **Community page** 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 page</hands-on-title>
>
> 1. Go to any training topic of interest. This will have the form
> ```
> https://training.galaxyproject.org/training-material/topics/<your topic here>
> ```
> 2. Add a /community to the end of the url.
> ```
> https://training.galaxyproject.org/training-material/topics/<your topic here>/community
> ```
> 3. Explore the community page!
>
{: .hands_on}
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="Galaxy Project Single-Cell Maintainer">
</iframe>
#
# Conclusion
{% icon congratulations %} Congratulations! You've made it to the end! Hopefully you think **SIGs** are brilliant and maybe you have joined one, or want to start one!
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

0 comments on commit ab9afa0

Please sign in to comment.