Giter VIP home page Giter VIP logo

Comments (4)

sbesson avatar sbesson commented on September 6, 2024

Renaming omero-guides to ome-guides (using /omero/, /bio-formats/, maybe eventually /idr/ prefixes?) generally makes sense to me and is a good direction

Re implications, there might be a jekyll_redirect_from-like solution at the readthedocs level but this is something that vanilla Sphinx has always lacked. Assuming all URLs would be broken by the renaming, the best solution might be to create a shallow compatibility repository similar to https://github.com/openmicroscopy/openmicroscopy.github.io that solely redirects all published guide URLs to the new ones.

from omero-guides.

sbesson avatar sbesson commented on September 6, 2024

As guides are being created outside the initial OMERO scope and these guides are getting increasingly promoted across our resources (see #2 and ome/www.openmicroscopy.org#393), we might need to come back to this issue in the near future.

Collecting a few thoughts while reviewing URLs recently:

  • handling guides across separate components can be handled either via URL path i.e. http://<guide_domain>/{omero,bio-formats/...} or via the URL domains. My personal preference goes towards the first solution as it aligns more closely with our current strategy (reference doc, website)
  • if we use a single guides domain, we might look into the options for using e.g. guides.openmicroscopy.org and defining a CNAME in readthedocs
  • most guide URLs include a /docs/ subpath which is inherited from the source code layout and could be reviewed

in all cases, a first step might be to create a list of all the published guide URLs to start scoping the redirection work.

from omero-guides.

jburel avatar jburel commented on September 6, 2024

the line between omero/idr is not as clear as one would like especially on the analysis front. We went that path for ITR/IDR notebooks and it creates a good amount of overhead in the setup for only the "saving step to OMERO" being the difference.

from omero-guides.

jburel avatar jburel commented on September 6, 2024

we also have guide starting to use other tools e.g. qupath-guide using https://github.com/glencoesoftware/ome-omero-roitool
in that case the "ome" (as ecosystem) will make more sense

from omero-guides.

Related Issues (17)

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.