Spec v2

[K-Meech]

fixes https://github.com/mobie/mobie.github.io/issues/51, https://github.com/mobie/mobie.github.io/issues/68 and https://github.com/mobie/mobie.github.io/issues/67

Finally got around to updating mobie.github.io for the new MoBIE version! This is a huge diff, so it's probably easiest to just browse from the index.md for this branch: https://github.com/mobie/mobie.github.io/blob/spec_v2/index.md

@tischi @constantinpape Anything else need adding here?

[tischi]

Thanks a lot! I would just merge it and then fix bugs. Looking at the diff is too cumbersome... OK?

[constantinpape]

I will have a quick look at the diff later and then merge @tischi.

[tischi]

OK, browsing from the index works 😄

One issue:

Service endpoint - the location of your S3 object store

I would write something that this only applies if using an AWS managed object store. If one uses some other object store, e.g. at EMBL-EBI this should be left blank.

[tischi]

Another thing, I would probably make CLI calls be code, e.g.

Instead of

$ aws s3 sync /path/to/my/project https://s3.embl.de/my-bucket

Do this (with the back ticks)

$ aws s3 sync /path/to/my/project https://s3.embl.de/my-bucket

[K-Meech]

Good points! I'll make these changes

[K-Meech]

I would write something that this only applies if using an AWS managed object store. If one uses some other object store, e.g. at EMBL-EBI this should be left blank.

@tischi - do you have an example of this? How does the project know where to fetch images from if this is blank?

[tischi]

I don't have an example, but here:

https://github.com/mobie/platybrowser-project/blob/8a04f91a32fd2cad013d9d1aa30c105b9bcc1864/data/1.0.1/images/remote/prospr-6dpf-1-whole-ache.xml#L28

This would also work like this:

    <ImageLoader format="bdv.n5.s3">
      <Key>0.6.3/images/local/prospr-6dpf-1-whole-ache.n5</Key>
      <SigningRegion></SigningRegion>
      <ServiceEndpoint>https://s3.embl.de</ServiceEndpoint>
      <BucketName>platybrowser</BucketName>
    </ImageLoader>

[K-Meech]

Ah ok - you mean the signingRegion? Not the serviceEndpoint?

[tischi]

yes, sorry if i mixed it up.

[K-Meech]

I make all the fixes in the last commit :)

[K-Meech]

I'll go ahead and merge this.

[tischi]

did you bump the patch version?!

[K-Meech]

No I didn't. Should I do that now? (it's already merged...)

[tischi]

Yes, you could do it directly in develop.

[K-Meech]

I'll just do this straight into master, as there's no develop branch for the docs repo

[K-Meech]

I take it back - there is a develop branch! I just didn't know it existed haha

[K-Meech]

Ah I can't bump the version - because there is no pom in this repo, it's only markdown. If there's anywhere else to change the version, let me know.

[constantinpape]

Given that this repo only contains the schema and docs it does not make sense to add a pom. We can instead use github releases (which just map to git tags) to keep track of version changes.

We currently don't have a release yet, but it's easy to create one via the Create new release button.

But we should define what exactly a release here means, as it makes most sense to use it to keep track of changes in the sepc (as defined by the jsonschema)

My initial thought was to create a 0.2.0 once the current spec is fixed (which I think is the case now).

[K-Meech]

Sounds good to me! I'll make a separate issue for this.