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.

Sign up for GitHub

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

Update README.md #230

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Update README.md #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 24 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
Galaxy Codex
============

Galaxy Communities Dock aka Galaxy Codex is a catalog of Galaxy resources (tools, training, workflows) that can be filtered for any community.
Galaxy Communities Dock (Galaxy CoDex) is a catalog of resources for Galaxy communities.

This repository stores the sources to build this catalog and its content. The catalog is automatically updated every week.
Currently, we have two main resources:

Any Galaxy community can be added to this project and benefit from the dedicated resources, including interactive tables that can be embedded into subdomains and website via an iframe. **Learn [how to add your community](https://training.galaxyproject.org/training-material//topics/dev/tutorials/community-tool-table/tutorial.html) in the dedicated GTN tutorial**.
1. **Galaxy Community Catalog**: from tools, training & workflows
2. **Galaxy Labs**: (led by Galaxy Australia!) main and tool panel content for communities to spin up subdomain pages

# Catalog content
This repository stores the sources to build all of this content. The catalog is automatically updated every week.

# Join the CoDex
Any Galaxy Community can be added to this project and benefit from the dedicated resources.
**Learn [how to add your community](https://training.galaxyproject.org/training-material/topics/community/faqs/codex.html)** in the dedicated GTN tutorial.

# Galaxy Community Catalog
To generate interactive tables that can be embedded into Galaxy Labs (subdomains) and websites via an iframe.
**Learn [how to generate the Galaxy Community Catalog](https://training.galaxyproject.org/training-material//topics/dev/tutorials/community-tool-table/tutorial.html)** in the dedicated GTN tutorial.

# Galaxy Lab
To generate GalaxyLab content, you can follow our documentation (to be added!).
To spin up a GalaxyLab on your server, you can follow our documentation (to be added!).

# Galaxy Community Catalog content

## Tool table

Expand Down Expand Up @@ -42,4 +57,8 @@ Suite users on main servers | Number of users of the suite on all UseGalaxy ser
Suite runs (last 5 years) on main servers | Number of runs of the suite tools in the last 5 years on all UseGalaxy servers
Suite runs on main servers | Number of runs of the suite tools on all UseGalaxy servers
Deprecated | Deprecation status after review by a domain expert
To keep | Status to add to a community after review by a domain expert
To keep | Status to add to a community after review by a domain expert

# Vocabulary
**Galaxy Lab**: Formerly known as Subdomains, Galaxy Australia built a new method for generating the main and tool panels for a Galaxy subdomain, known as a Galaxy Lab.
**Galaxy Community**: Galaxy Community of Practice. You can see a full list of Special Interest Groups in the [SIG Directory](https://galaxyproject.org/community/sig).