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

Create matrix bot FAQ #5667

Merged
merged 4 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
18 changes: 18 additions & 0 deletions topics/community/faqs/matrix_news_bot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: How do I add a news feed to a Matrix channel?
box_type: tip
layout: faq
contributors: [nomadscientist, hexylena]
---

1. You must be an *Admin* in the channel. Find this out by going to the channel and selecting **Room info** --> **People**, or clicking on the little circle images of people in a channel. Admins can make other admins.

2. Go to **Room info** --> **Extensions** --> **Add extension** --> **Feeds**

3. Under *Subscribe to a feed*, add a URL from this [GTN feeds listing]({% link feeds/index.md %}). Make sure that it ends in `.xml`. For example, `https://training.galaxyproject.org/training-material/topics/community/feed.xml` would provide updates on any community-tagged GTN materials into the Matrix channel.

4. Under *Template*, change the existing text to the following: `$LINK: $SUMMARY`

5. Provide a reasonable name, and then hit **Subscribe**!

Details from Matrix are here: https://ems-docs.element.io/books/element-cloud-documentation/page/migrate-to-the-new-github-and-feeds-bots
77 changes: 43 additions & 34 deletions topics/community/tutorials/community_content/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ time_estimation: "30M"
key_points:
nomadscientist marked this conversation as resolved.
Show resolved Hide resolved
- "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
- shiltemann
requirements:
-
type: "internal"
Expand Down Expand Up @@ -51,25 +51,29 @@ To help topic maintainers to quickly recognise what materials need updating and

> <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 %}
>
> 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 Home!
> - For example, the [Single Cell Maintainer Home]({% link topics/single-cell/maintainer.md %})
>
{: .hands_on}

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

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"
src="https://training.galaxyproject.org/training-material/topics/single-cell/maintainer.html"
width="100%"
height="400"
style="border: 2px solid #00008B;"
height="800"
style="border: none;"
title="Single-Cell Topic Maintainer Home">
</iframe>

Expand All @@ -79,23 +83,25 @@ Where the **Maintainer Home** helps you sustain your community, the **Community

> <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 %})
> 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 Home!
>
{: .hands_on}

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

<iframe
src="/training-material/topics/single-cell/community.html"
src="https://training.galaxyproject.org/training-material/topics/single-cell/community.html"
width="100%"
height="400"
style="border: 2px solid #00008B;"
height="800"
style="border: none;"
title="Single-Cell Topic Community Home">
</iframe>

Expand All @@ -105,24 +111,25 @@ Next up, you might want to know how many people are actually using your material

> <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)
> 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>/maintainer.html#statistics-for-your-materials
> ```
> 3. Explore the usage statistics!
>
{: .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"
src="https://training.galaxyproject.org/training-material/topics/single-cell/maintainer.html#statistics-for-your-materials"
width="100%"
height="400"
style="border: 2px solid #00008B;"
height="800"
style="border: none;"
title="Single-Cell Topic Usage Statistics">
</iframe>

Expand All @@ -133,12 +140,14 @@ You can also embed news into your pages, subdomains/ Galaxy Labs, or even your M
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 %} )
2. Bot integration into matrix

{% snippet topics/community/faqs/matrix_news_bot.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>
<iframe width="100%" height="300px" src="https://training.galaxyproject.org/training-material/feeds/single-cell-month.w.html"></iframe>
shiltemann marked this conversation as resolved.
Show resolved Hide resolved

# Workflow search

Expand All @@ -152,7 +161,7 @@ Follow this documentation to learn how:
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="400px" width="100%" class="gtn-embed" frameborder="1"></iframe>
<iframe src="https://training.galaxyproject.org/training-material/workflows/embed.html?query=single-cell" height="600px" width="100%" class="gtn-embed" frameborder="1"></iframe>

# Galaxy Community Activities calendar

Expand Down
Loading