Zarr integration into online resources

[joshmoore]

There have been several discussions around where to put the various information that's been developed during the OME Zarr Spike. Several new repositories like https://github.com/ome/ome-zarr-py and https://github.com/ome/omero-ms-zarr need integrating, likely at multiple locations. Additionally, some flows may need modifying. In general, there are at least 3 different types of locations we should be thinking about:

• spec: formal definitions that are versioned based on the format itself
• docs: per-code-release-updated reference material with installation instructions, etc.
• guides: workflow-based expository texts which point to the other two types

An initial stroll through the documentation shows these related pages (along with comments):

.
├── docs                         Main location for definitive reading
│   ├── ome-files                Main location for non-OMERO, non-Bio-Formats work
│   │   └── cpp                  However _only_ C++ is listed. Suggest "specs" section
│   ├── bio-formats              
│   │   └── conversion        ** Currently no section on bioformats2raw
│   └── omero                    
│       ├── cli-for-users     ** Currently no location for finding out about pip installs
│       └── ms-for-admins     ** Currently no location for finding out about microservices
├── guides                       
│   └── general-concepts         
│       ├── export-download      Possible location?
│       ├── public            ** Possible location?
│       └── cli-extensions    ** Less critical but conceivable
│       └── server-extensions ** Less critical but conceivable
└── www                          
    ├── ome-files                
    │   ├── ome-tiff-spec     ** Needs extracting from ome-model
    │   └── ome-zarr-spec     ** Needs extracting from omero-ms-zarr
    └── training                 
        └── materials            Currently OMERO focused

(**) New pages

Possible actions for discussion:

• http://docs.openmicroscopy.org/ome-files
  • [ ] split into ome-files-cpp and other pages
• http://docs.openmicroscopy.org/bio-formats
  • [ ] add minimally link if not docs about the bioformats2raw package
• http://docs.openmicroscopy.org/omero
  • [ ] add user link to PyPI packages
  • [ ] add admin link to microservices
• https://omero-guides.readthedocs.io/en/latest/
  • [ ] rename to ome guides
  • [ ] include zarr/napari logo
  • [ ] add a "public data" section, possibly split into "creation" and "access"
  • [ ] potentially add more general guides on the CLI & Microservices, though this potentially conflicts with the docs page
• https://www.openmicroscopy.org
  • [ ] update ome-files page to include links to specs
  • [ ] extract ome-tiff-spec from ome-model
  • [ ] extract ome-zarr-spec from omero-ms-zarr
  • [ ] add a higher level link to the guides

[jburel]

• Guides have been "omero" focus even if we only use public data (mostly from IDR) for the examples, agree that a rename is necessary.
• guide has info about cli-import to describe workflow. The CLI admin section is work in progress so possible opportunity to add more material. I will be more in favour of using guides for new material (cf. conflict point)

[jburel]

Initial discussion about renaming https://github.com/ome/omero-guides/issues/5

[jburel]

• Section to "upload to S3" could be added to the guide under "upload/import"

[joshmoore]

• Section to "upload to S3" could be added to the guide under "upload/import"

Probably worth reviewing that along with the full list of guides, but I don't see these two things as being the same. Possibly along with the renaming though everything will fall into place.

[jburel]

As it stands you are right they are not the same, this is more after renaming/breaking up sections