ga4gh-schemablocks / ga4gh-schemablocks.github.io

Website of the GA4GH SchemaBlocks Project
The Unlicense
2 stars 6 forks source link

Unify the two genome-coordinates pages #7

Closed jmarshall closed 5 years ago

jmarshall commented 5 years ago

The two genome-coordinates pages duplicate quite a lot of information and list some further requirements that are unnecessary and a distraction from the goal of recommending the use of 0-based half-open / interbase coordinates in GA4GH APIs.

This PR merges the salient additional information from genome-interval-coordinate-use.md into the other file. (I look forward to the author of that page (@andrewyatz)'s comments on this commit when he's back in the office next week.)

The other file is then renamed back to the original genome-coordinates.md filename and title, as it describes “0-based half-open” and “interbase” equally.

See new comments on the original issue #3 and PR #4 for discussion of the decisions here.

(Using image markdown like ![Sequence data with 1-based coordinates](/assets/img/genome-coordinates-img/1-based.svg) means that the image is viewable both on the GitHub Pages web site and in the source code repository view.)

mbaudis commented 5 years ago

@jmarshall O.k.; here now a summary answer to the last points:

So, how to proceed w/ this PR? I've moved the content of this page already to master (for now considering this acceptable while setting up some more formal way in parallel...); the part about the "current use" refers to the additional p[age.

My wish/recommendation

mbaudis commented 5 years ago

@jmarshall A reminder of where we were at, in contrast to my last comment here: One-page merge for recommendation & current use https://github.com/ga4gh-schemablocks/ga4gh-schemablocks.github.io/issues/3#issuecomment-467823973 (in which I would like to keep the table, but collapsing the interbase and 0 into 0 (w/ footnote or such). Can you (and maybe @andrewyatz) do this?

jmarshall commented 5 years ago

You seem to be saying that you are on board with re-unifying this as one page. This PR is my concrete proposal of how to do that: it merges the information into the original genome-coordinates.md filename, uses Liquid relative_url as requested, and does so in git commits that strive to accurately reflect their authorship.

The text I wrote in Existing GA4GH products was intended to distill the correct information from the table. We could re-add the table in some form on this PR, or we could merge PR #7 as is and then workshop re-adding the table separately. The latter would probably be easier.

Can you (and maybe @andrewyatz) do this?

Okay, how about the latter for a plan: I will merge this #7 as is, and then (with the baseline thus tidied up) a follow-up PR re-adding the table in some form and moving some of that text into it can be proposed and discussed.

jmarshall commented 5 years ago

Okay, I've merged that (with the front matter author: listing those who have written text that is in the page — if others who have been part of past discussions should be re-added, that can be done on master).

Onward to a discussion about how to further break up the wall of text with a useful table!