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

Make standards information more findable #7

Closed
mcupak opened this issue Feb 7, 2020 · 3 comments
Closed

Make standards information more findable #7

mcupak opened this issue Feb 7, 2020 · 3 comments

Comments

@mcupak
Copy link
Collaborator

mcupak commented Feb 7, 2020

It would be good if we could increase findability of GA4GH standards across workstreams. While officially approved standards are easy to find, standards that are work in progress are a bit more of a challenge.

The issue is two-fold - how do I find the specs that are relevant for me, and how do I find their docs.

For specifications, there are a number of GH organizations that don't necessarily map to workstreams/projects (e.g. ga4gh-beacon for the Beacon Project, ga4gh-discovery for Discovery WS except Beacon, ga4gh for effectively the Cloud WS?). Within organizations, it's still not easy to see which repositories are standards vs. other tools (e.g. https://github.com/ga4gh). Maybe have some sort of a catalog/labelling?

For docs, it would be nice if there was more consistency. We're using different formats (e.g. Discovery, Cloud), and the information is usually split between some page and individual GH repos. Maybe we can have some sort of a central website with docs or links to docs?

@jb-adams
Copy link
Member

@mcupak I think GA4GH would benefit from this a lot. I had an idea of the "Standards Lookup API" we discussed serving as an underlying layer for some sort of "standards explorer" web interface.

It could capture the following information about each standard:

  • basic metadata (name, version(s), etc.)
  • status (approved, proposed, no longer supported, etc.)
  • link to OAI spec (the .yaml file and/or repository containing the spec)
  • link to human-readable documentation
  • semantic tags/labels so newcomers can filter by what standards are relevant to their use case

An explorer UI/website could be built on top of this, serving as a centralized location for all standards (essentially one-click away from any standard). This would let teams continue to develop in any Github org, while still making sure all GA4GH outputs are accessible from a common location.

Is this something along the lines of what you're thinking?

@mcupak
Copy link
Collaborator Author

mcupak commented Feb 10, 2020

Thanks @jb-adams, sounds like that would certainly help with the first part of the issue (repos), and what you're proposing is more sophisticated than what I was thinking about. I'm looking specifically for findability of specifications and projects that are under development for use within GA4GH and didn't realize your API would deal with this as well, that's great!

For the docs part, if we can't have everything in one place, I think it could be useful to provide a deployable template to use.

@rishidev
Copy link
Collaborator

rishidev commented Feb 17, 2020

As I understand it, the part that Jeremy has mentioned is based on Issue #1, so we can maybe continue the thread in there.

The website part is something to discuss with the comms team, a website update is being planned, and that would be the forum for that discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants