croissant icon indicating copy to clipboard operation
croissant copied to clipboard

Prepare web redirects for Croissant vocabulary namespace/URIs, spec, and documentation for 1.1 version

Open kepae opened this issue 4 months ago • 1 comments

Breaking out this issue from #923 discussion. Aside from handling human- and machine-readability of Croissant vocabulary, there need to be redirects that will handle lookups to Croissant URIs, handling both the current 1.0 and upcoming 1.1 versions. This would successfully resolve terms under the mlcommons.org/croissant namespace (such as http://mlcommons.org/croissant/Field, which yields a 404).

The strawman describes using a one-page "hash" namespace:

Strawman suggestion:

  1. Create a redirect from mlcommons.org/croissant/1.0/term to mlcommons.org/croissant/1.0#term
  2. Same thing for 1.1: mlcommons.org/croissant/1.1/term to mlcommons.org/croissant/1.1#term
  3. Redirect mlcommons.org/croissant/term to mlcommons.org/croissant/1.0/term until we launch 1.1 and then to mlcommons.org/croissant/1.1/term

Originally posted by @benjelloun in #923

For now, I propose just serving the current markdown spec from the mlcommons.org/croissant namespace to make use of what we have, and can improve later.

MVP steps (discussed a little in https://github.com/mlcommons/croissant/issues/923#issuecomment-3145127994):

  • [x] Serve current markdown spec from mlcommons.org/croissant/1.0 (or setup re-direct)
  • [ ] Make sure redirects follow default versions and keep terms follow to proper anchors per above: mlcommons.org/croissant/term -> mlcommons.org/croissant/1.0#term
  • [ ] ~If desired, resolve the bare namespace – mlcommons.org/croissant – to the spec, rather than the working group (currently goes to https://mlcommons.org/working-groups/data/croissant/ )~

If we really wanted to do something quick, we could just handle redirects directly for all Croissant terms in the RDF, e.g. croissant:FileSet. however the docs are served: https://docs.mlcommons.org/croissant/docs/croissant.ttl

kepae avatar Aug 12 '25 14:08 kepae

Hi Kevin,

mlcommons.org/croissant/1.0 already redirects to the current spec.

The main thing that is missing is the redirect from mlcommons.org/croissant/term to mlcommons.org/croissant/1.0#term. We may write it as redirect rules that do:

  • mlcommons.org/croissant/term -> mlcommons.org/croissant/<default_version>/term
  • mlcommons.org/croissant//term -> mlcommons.org/croissant/version#term where default_version is 1.0 now, and changes to 1.1 later.

I think we want to keep mlcommons.org/croissant pointing to the working group page, since we've been sharing that URL quite a bit already.

benjelloun avatar Aug 18 '25 12:08 benjelloun