Skip to content

Add registration process.#78

Open
wes-smith wants to merge 1 commit into
mainfrom
add-registration-process
Open

Add registration process.#78
wes-smith wants to merge 1 commit into
mainfrom
add-registration-process

Conversation

@wes-smith

@wes-smith wes-smith commented May 5, 2026

Copy link
Copy Markdown
Collaborator

This PR adds a description of the registration process for requesting registry entries.

Fixes #46.


Preview | Diff

Comment thread index.html
Comment on lines +595 to +596
To register an entry in the range <b>256-65,535</b>, a mature specification or standard document
must be provided alongside the request. These requests will undergo expert review before allocation.

@dlongley dlongley May 5, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to say that the spec/standard must be with an SDO -- or something similar. I think it would be challenging (for reviewers) to determine whether any "spec" document is otherwise "mature" or stable, etc. This could, for example, be based on similar rules that W3C uses today for normative references.

Comment thread index.html
<b>256-65,535</b>: Specification required
</li>
<li>
<b>65,536+</b>: First come, first serve

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<b>65,536+</b>: First come, first serve
<b>65,536+</b>: First come, first served

Comment thread index.html
<p>
To register an entry, follow the instructions in <a href="https://github.com/json-ld/cborld-registry">the README</a>. The registry is owned by the W3C JSON-LD Community Group.
Registration requests must be in the form of pull requests raised against the CBOR-LD Registry
from a fork of the repository. These requests must include:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
from a fork of the repository. These requests must include:
via a fork of the repository. These requests must include:

Comment thread index.html
The use case for the registry entry,
</li>
<li>
A .yml file added to the `tables` directory, with the Registry Entry ID requested as the filename,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A .yml file added to the `tables` directory, with the Registry Entry ID requested as the filename,
A `.yml` file added to the `tables` directory, with the Registry Entry ID requested as the filename,

Comment thread index.html
</p>
<p>
Reasonable and conformant registration requests for ID <b>65,536</b> or higher will be merged by
the registry repository maintainers on a first-come-first-serve basis without additional review.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the registry repository maintainers on a first-come-first-serve basis without additional review.
the registry repository maintainers on a "first-come, first-served" basis, without additional review.

@iherman

iherman commented May 6, 2026

Copy link
Copy Markdown
Member

A minor, editorial comment: 65,535 (and other) numbers use the US approach to separate the thousands. It is not the same in other languages and/or countries (for the fun, you can look at the wikipedia page). I realize W3C standards use American English, but numbers are sometimes more difficult to "switch" for a reader.

All this to say that may be probably better to write 65535.

@iherman

iherman commented May 6, 2026

Copy link
Copy Markdown
Member

Some questions that we may want to discuss:

  • Who does the review? Is it the responsibility of the JSON-LD WG while it exists, and W3C team otherwise? Or do we want to gather a list of volunteers as for the DID method registry?
    -Do we plan to have a safe backup of the registry, or do we simply want to trust github (ie, Microsoft) for something like this?
  • Will the registry entries have a stable URL to refer to, ie, to retrieve the registry if necessary, or do we simply say to the implementer: "get it from github using whatever tool you want"?
  • (This question will obviously come:) why not a W3C registry? (Whatever that means...)

@pchampin

pchampin commented May 6, 2026

Copy link
Copy Markdown
Contributor

Guidelines for non-W3C normative references:
https://www.w3.org/guide/process/tilt/normative-references.html

@TallTed

TallTed commented May 6, 2026

Copy link
Copy Markdown
Member

Also note https://www.w3.org/guide/tools/
and its link to the dysfunctional normative references checker

@wes-smith

Copy link
Copy Markdown
Collaborator Author
  • Who does the review? Is it the responsibility of the JSON-LD WG while it exists, and W3C team otherwise? Or do we want to gather a list of volunteers as for the DID method registry?

Maintainers of the various JSON-LD specifications are responsible for this, with W3C staff as backup.

We will move the other questions into a separate issue for tracking and to unblock this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Define registration process

5 participants