Code Monkey home page Code Monkey logo

galaxy-hub's Introduction

Galaxy Community Hub

The Galaxy Community Hub ↗️ is the community and documentation website for the Galaxy Project↗️. The Hub is maintained by the community through this GitHub repository. To update the Hub, (1) visit the Hub "About" page↗️ and (2) view the links in this README.md file Table of Contents.

About the Galaxy Project

To learn more about the Galaxy Project, visit the Hub "Home" page↗️.

Table of contents

  1. Structuring Content, Files, and URLs
    1. Markdown - How to format paragraphs and images
    2. File Organization and URLs - How to name files and structure URL paths
    3. Static and Dynamic Pages - How to display list of pages, custom layouts, and categorized pages
    4. Subsites - How to access existing subsites or start your own Hub subsite
  2. Contributing Content, Images, and Code (multiple options to publish changes)
    1. [Option 1] Editors - Do it all in Github
    2. [Option 2] Developers - Clone the repository (and run in your local environment)

License

The contents of the Galaxy Hub are licensed under the Creative Commons Attribution 4.0 International License.

The code behind the infrastructure is licensed under the MIT License

galaxy-hub's People

Contributors

afgane avatar assuntad23 avatar beatrizserrano avatar bebatut avatar bgruening avatar dannon avatar dependabot[bot] avatar electronicblueberry avatar erxleben avatar fubar2 avatar github-actions[bot] avatar hexylena avatar hrhotz avatar hujambo-dunia avatar jennaj avatar mariipia10 avatar martenson avatar melkeb avatar mira-miracoli avatar moheydarian avatar nakucher avatar natwhitaker avatar nekrut avatar nicksto avatar nomadscientist avatar nsoranzo avatar quickbeasts51429 avatar subinamehta avatar tnabtaf avatar vjalili avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

galaxy-hub's Issues

NewsGraphics are missing

Many images that are supposed to be under /src/images/NewsGraphics are missing.
E.g. src="/images/NewsGraphics/2016_07_GalaxyRelease_Highlights.png" alt="v16.07 Galaxy Release Highlights"

Should we get some manually?

Markdown image links pointing to root directory.

The top of Admin/ToolPanel/index.md is being generated as:

<div class='right'>![Tool labels](/src/Admin/ToolPanel/tool_labels.png)</div>
# Tool Panel Administration

Which I think is correct. However, the html coming out of metalsmith is:

<div class='right'><img src="/tool_labels.png" alt="Tool labels"></div></p>
<h1 id="tool-panel-administration">Tool Panel Administration</h1>

which I don't think is correct because the image is in the Admin/ToolPanel directory.

This seems to effect all/most images that use MarkDown notation, and none of the ones using HTML, if that helps.

brilliantly handle redirects from wiki to hub

I believe we have to set up a remarkably well working redirects because the old wiki urls are linked throughout the internets and you know...urls are forever.

Given that there will be efforts to move things around the hub (for better, like here: #36) it is even more important to redirect smart.

Sadly, we will have to maintain, at least for major wiki pages, the redirects together with the new content. Let's create a way to do that.

Menu Clutter

The menu just became very cluttered with #117 and #116 @nekrut @martenson.

We should narrow this down to maybe (5?) options, and we can change to a two-tiered list if necessary.

image

Establish a Governance Model

The grant PIs are hosting this with grant resources so I think it would be completely appropriate to have a top-down governance model for how this repository is operated - editorial control may be required. Is this going to be the case or is there going to be an appetite for some open, community driven governance of this repository's policies/contents?

Multiple pages mention only universe_wgsi.ini not config.ini

Rename to galaxy-hub ? (RFC)

Now that we have a set name, and before we get too far into using this, should I rename this repository galaxyproject/galaxy-hub?

Community Hub Contribution Convergence (CHCC), Thursday December 8

Content for this site was automatically converted from the old MoinMoin and Creole markup to Markdown, and many other things were also cleaned up in the process. However, the automatic translation stumbled in some places and the cleanup and general restructuring are far from done. We also aren't yet taking advantage of Metalsmith to render semi-structured content and page metadata.

The Community Hub Contribution Convergence (CHCC): Thursday December 8

To address these issues we are holding the Community Hub Contribution Convergence (CHCC) online this week on Thursday December 8. The goals of CHCC are to

  • Get participants up to speed on how to update the new site.
  • Create / improve documentation on how to update the new site.
  • Fix translation errors and things that were accidentally dropped
  • Generally reorganize and update documentation.
  • Drop obsolete material
  • Work out plans and best practices for supporting semi-structured content and page metadata.

CHCC will use this issue to coordinate work, and a Gitter channel for communication during the event. Interested? Please join us.
The Hub uses GitHub Flavored Markdown for markup, and Metalsmith for web site rendering and for semi-structured content (such as the Events page). The new platform offers the strength of our old wiki (easy contribution) with a markup language many more people know, easy programmatic access, and all the strengths of GitHub.

Once the Hub is in better shape it will become the galaxyproject.org site. Until then you can find it at new.galaxyproject.org. Once the move is complete the old wiki will be shut down.

Issues

Please add issues as you identify them. In general, any open issue is a good target to work on.

Semi-Structured Content: Best Practices

Hi All,

One of the reasons for using Metalsmith in the new site is that it is much more powerful when it comes to rendering semi-structured content than was MoinMoin. By semi-structured content I mean directory pages such as:

Some of these used MoinMoin's semi-structured support. These did not translate well, but should be easiest to adapt. Some use just repeating markup that should be moved to semi-structured content. These may be more tedious to migrate.

Prototype: Community Deployments Catalog

I suggest we use Community Deployments directory (and the entries too) to prototype our efforts. I think this is the simplest place to start. (And I think Events will be the hardest to port, and we should wait until last to do that.)

What I would like to see is something like what's in the old wiki:
https://wiki.galaxyproject.org/Community/Deployments

In an ideal world the default sorting would ignore case, and users could sort by any column. Note that this page also supports two different displays of the information.

Porting this would require

  1. moving what had been MoinMoin dl/dd/dt markup into YAML header information (look for <div class='deploymentbox'> in the page source), and
  2. writing a Metalsmith plugin to to render it (perhaps one already exists?).

Blog Support

One of our stated goals when we started this move was to support other types of content, including blogging. Blogs are analysis/opinion and differ from most of the hub content in that way. However, they can still play a key role in helping people understand Galaxy and data-intensive research.

Does anyone want to take this on?

I'm guessing it would involve using a standard set of YAML tags for blog pages. In decreasing order of importance here's what I would like to see supported:

  1. List recent blog posts in reverse chronological order. I could see putting this on the blog home page (maybe /src/blogs/index.md ?), and maybe on the hub home page.
  2. Support blog posts that are just a short summary of, and link to, an external blog page.
    • I don't want to require people to use this platform, but I want to aggregate everything in one easy to find place
  3. List blog posts with a particular author, in reverse chronological order
    • Support more than one author per blog entry
  4. Support tagging
  5. List blog posts with a particular tag
  6. Show a word cloud / list of blog tags along with counts for each tag.
  7. Figure out if and how this integrates with or replaces the current Community Log Board, which basically aggregates external blog posts about administering Galaxy into one place.

Another option is to use BioStar for this. One of the "Post type"s it supports is "Blog." Right now it appears we only use that for entries from the GalaxyEvents Google Calendar.

I lean towards using the Hub over BioStar as I think the Hub is a better fit for blogging.

anchors do not match targets

the links are #shutting_down_galaxy but the targets are #shutting-down-galaxy

Not sure how prevalent it is but I would assume site-wide.

Copying fontawesome fonts

Need a bower-files override for fontawesome fonts that works. Tried both in bower, build (as a bower-files argument) and other things, but couldn't get bower-files to cooperate. Need to debug more and figure out why even overrides aren't adding these to the registry for copy-in.

Autotoc for which pages?

Currently only pages which had a TABLE_OF_CONTENTS are autotoc'd. @tnabtaf mentioned in email that it might be preferable to 'upgrade' this to all pages by default, which we could do and just swap the autotoc flag in the front matter to a disable.

'edit on github' button sends to wrong url

It sends to https://github.com/galaxyproject/galaxy-hub/blob/master/src/Admin/GetGalaxy/index.md instead of https://github.com/galaxyproject/galaxy-hub/blob/master/src/admin/get-galaxy/index.md.

Capitalization seems to be the problem.

News metadata, pages and summaries

News and Events need to be tagged with two fields in the yaml frontmatter, like:

-date: '2016-12-01'
-tease: "Here's a small teaser line with more info"

With these defined, contents will automatically show up in feeds like on the homepage, under News, Events, etc.

A few broken links

A few links are broken:

"404 Not Found":

Placeholder errors:

others

What should we call this web site?

Hi All,

We needed to call the new site something in the initial announcement, so we did. However, we'd like have community input on what to call the new site before we officially make the swap.

The old site was clearly a wiki. The new site has wiki-like characteristics, but it's not a wiki and calling it that might be misleading. Our goals for the new site are to support community curated Galaxy documentation and a much broader range of content then the original wiki and the name should reflect that.

Here are two ideas from the team to start the discussion:

  • Commons: Galaxy Community Commons, Galaxy Commons, Community Commons
    • It certainly is a "commons", but ...
    • Easy to confuse with recent NIH efforts.
    • That acronym is already taken.
  • Hub: Galaxy Community Hub, Galaxy Hub, Community Hub
    • Name reflects the goal of the site.
    • Not obviously confused with other prominent resources (that I know of!)

Any suggestions, preferences or thoughts?

Bunch of missing pages

edited, sorry @scholtalbers to hijack your issue

  • src/Admin/Tools/ToolDependencies.md
  • src/Admin/Training/ISMB2010%20Galaxy%20Tutorial%3A%20Running%20Your%20Own.md
  • src/CloudMan/CustomizeGalaxyCloud.md
  • src/Community/TemplateCreole.md
  • src/events/GCC2011/Sample%20Tracking%20and%20Instrument%20Integration.md
  • src/events/GCC2011/Thinking%20Big%3A%20CloudMan%2C%20Grid%2C%20and%20Scalability.md
  • src/events/GCC2011/Visualization%20and%20Visual%20Analytics.md
  • src/events/GCC2011/Workflows%20and%20API.md
  • src/Future/Job%20Failure%20When%20stderr.md
  • src/Learn/Datatypes/index.md
  • src/Learn/Interactive%20Poster.md
  • src/Learn/OpenID%20Login.md
  • src/Learn/Screencasts/CurrentProtocolsBioinfo2012.md
  • src/Learn/Screencasts/GR2007%20Screencasts.md
  • src/Learn/Share/Share.md
  • src/Learn/UCSC%20Galaxy%20Integration.md
  • src/Learn/Uploading%20and%20Analyzing%20Genotype%20Data%20in%20Plink%20Format.md
  • src/Learn/UserAccounts/UserAccounts.md
  • src/Main/DataLibraries/Genome%20Data.md
  • src/Main/DataLibraries/Microbes/A-J.md
  • src/Main/DataLibraries/Microbes/K-Z.md
  • src/Main/DataLibraries/Microbes.md
  • src/news/GCC%20Creole.md
  • https://wiki.galaxyproject.org/Future/Job%20Failure%20When%20stderr
  • https://new.galaxyproject.org/support/ is missing 70% of its contents (everything below IRC section) original: https://wiki.galaxyproject.org/Support
  • https://wiki.galaxyproject.org/CloudMan/CustomizeGalaxyCloud/

make watch does not work for styles

In spite of detecting the changes, not sure if the error is related.

serving /Users/marten/devel/git/galaxy-hub/build at http://0.0.0.0:8080
[metalsmith-watch] ✔︎ Watching src/**/*
[metalsmith-watch] ✔︎ Watching layouts/**/*
Done
[metalsmith-watch] ✔︎ src/css/styles.less changed
[metalsmith-watch] - Updating 1 file...
[metalsmith-watch] ✗ Error: file "config/menu.yaml" not found

Create a subdirectory for user pages?

Hi All,

MoinMoin user pages were translated directly to the new site, meaning that they all exist at the top level of the /src directory. I'd like to propose that we create a separate directory for user pages, move them all there, and then update any links in the site to go to the new pages. This can all be done programmatically.

We could also change the page naming convention while we are at it. It is currently FirstLast.

Open Questions:

1. What do people think of the proposal?

2. Where should they moved to if we move them?

A couple of ideas come to mind:

/src/People/
/src/Community/
/src/Community/People/

3. Should we change the naming convention?

Issues with Moin to MD translation and attachments

The translation code did not handle attachments correctly/completely in several instances. If you search the tree for attachments you'll find 144 files with that string in it. Here are some examples of problems:

  • Admin/Config/Performance/ProductionServer/index.md
    • [Building Scalable Galaxy slides ](ATTACHMENT_URLEvents/GDC2010/GDC2010_building_scalable.pdf)
  • Admin/Tools/DataManagers/index.md:
    • <a href='/src/attachment:data_managers_figure_S1_schematic_overview.png/index.md'> <img src="/src/Admin/Tools/DataManagers/data_managers_figure_S1_schematic_overview.png" alt="" width=600 /></a>
  • Cloud/Jetstream/index.md:
    • [{{attachment:jetstream_GettingStarted.png||width="75%"}}|&do=get,target="_blank"](ATTACHMENT_URLjetstream_GettingStarted.png)
  • CloudMan/AWS/GettingStarted/index.md:
    • <a href='PLACEHOLDER_ATTACHMENT_URLAWSSetRegion.png'>{{attachment:AWSSetRegion.png|Set region; click to enlarge|width="200"}}|&do=get,target="_blank"</a>

I might take a look at these today.

Font missing

[metalsmith-serve] 18:19:39 [404] /fonts/fontawesome-webfont.woff2?v=4.6.3

Only build the changed files

If it is possible it would be super nice if the make build or make serve could only build the parts that were actually changed. This will also speed up later CI integrations.

Incomplete/format issues on critical wiki pages

Found so far:

  • Support is listed in the first two menus. Is this intentional? It could be removed from the first (Communicate) and be replaced with the Mailing List link (has mailing lists, irc, and biostars included, but not complete (IRC details) and links point to Support page items that do not exist right now - see below). Maybe name the menu item "Contact"?

  • If rename Mailing Lists to Contact, change this everywhere

  • https://new.galaxyproject.org/support/
  • lower content on the page is missing, this is very much used for user Qs
  • has old # info at top: #acl WikiAdminGroup:read,write,revert All:read
  • Learn - points to old wiki
  • Teach - points to old wiki
  • GalaxyProject.org → Execute a Custom search through all project content - the bold link points to the old wiki, the italic link doesn't go anywhere (but has new wiki URL)
  • Q&A at Galaxy Biostars (claim your account) - the bold link points to the old wiki
  • Galaxy Project Workshop 2015 - link points to old wiki
  • Known Issues - migrate all content to new wiki
  • Remove custom search boxes? and this: PLACEHOLDER_INCLUDE(/src/support/LinkBox/index.md)
  • Custom searches paragraph, "The MailingList search finds" - bold points to old wiki
  • Mailing Lists paragraph, all bullet items have new wiki URL but sections missing
  • IRC Channel paragraph - header only, is where content on page ends


  • https://new.galaxyproject.org/support/#mailing-lists
  • Consider renaming page to "Contact" - we probably just need one comprehensive contact summary page - it can link out if there are details we want to share
  • Bulleted links point to Support items that do not exist (Support needs to be restored first, or new pages created to replace the content as sub-items)
  • IRC details need to be added

Hunting for more

urls in linkboxes are not converted to new wiki page targets

and thus are 404ing

<strong><a href="../../../Tools">Galaxy Tools</a></strong>
----
<a href="../../../Admin/Tools/AddToolFromToolShedTutorial">Install from ToolShed</a><br />
<a href="../../../Admin/Tools/AddToolTutorial">Create Custom Tool</a><br />
<a href="../../../Admin/Tools/ToolConfigSyntax">Complete Tool Syntax</a><br />

----
<strong><a href="../../../ToolShed">Galaxy ToolShed</a></strong><br />
<a href="../../../ToolShed/PublishTool">Publishing Tools</a><br />
<a href="../../../IUC">Utilities Commission</a><br />
<a href="../../../ToolShed/HostingALocalToolShed">Hosting Tool Shed</a><br />
</div>

Large files

lots of large files (multiple gigs worth of pdfs, ppts, etc.) were being attached to the wiki. We need to come up with a plan for these that doesn't involve having them in the repo.

Where to put groups / teams / communities in directory structure?

This thread was inspired by a discussion about teams in issue #36, which is about where to put person pages,

It may be useful to have a defined place (or places) in the Hub directory structure for doc about groups related to Galaxy.

There are several types of groups to consider

  1. Domain and task based groups
    • Galaxy-Proteomics and Galaxy-P
    • Natural Language Processing
    • Intergalactic Utilities Commission (IUC): Tool wrapping, best practices, ToolShed.
    • Galaxy Training Network
    • GalaxyAdmins
    • Galaxy Committers
  2. Geography and language based
    • Galaxy Australia, Galaxy UK, Galaxy Pitagora, Galaxy Arabic, Galaxy France & IFB Galaxy Working Group
  3. Institutional
    • Freiburg Galaxy Team
    • Any university / research organization with a significant Galaxy presence

I'm going to argue that case 3 is distinct from the first two, and that this issue should focus on just the first two cases. Case 3, Institutions, can (and should be?) dealt with in a separate directory structure. If there is consensus on this split, we can create a separate issue for institutions.

Naming / Where to put this info?

The old wiki put this info in the Community hierarchy. Some thoughts for the hub:

/src/communities/
/src/groups/
/src/teams/

I favor /src/communities/ because, well, these are all communities, and I really like that word; or /src/groups/ because these are all groups, and that's less typing.

Metadata

I'd favor having the root page be largely driven by metadata on the subpages. The root page might be a directory generated from the subpage metadata. The subpages could contain metadata, plus any additional text specific to that community.

Standardize on ISO date format.

The hub currently uses a mix of ISO date formats (YYYY-MM-DD or YYYY/MM/DD) and American date formats (MM-DD-YYYY).

American date formats are brutally confusing to anyone who didn't grow up with it.

CI that checks every PR

Every PR needs to be checked, for example if all files/images bigger than X are commited via LFS, that no link is broken and many more.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.