w3c / w3c/json-ld-syntax

avoid the term "remote" when talking of "context by reference"

Open
#487 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
139
Forks
23
PR merge metrics
No merged PRs in 30d

Description

While we want to fight the misunderstanding that "@context": "https://..." requires you to make an HTTP request,
the current text of the specs (syntax and api) pushes readers into that direction.

I suggest that we should avoid as much as possible the term "remote", which strongly points towards "download over the network", to something more abstract.

Proposals:

  • external context (in the sense that it is external to the document that reference it)
  • replace RemoteDocument with DereferencedDocument (suggested by @TallTed), emphasising that there are many ways of "dereferencing" (from cache, from an internal registry of "well-known" contexts...)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read Section 3.1, "Contexts," in the syntax specification and Section 9.4, "Remote Document and Context Retrieval," in the API specification. Inventory the uses of "remote" and "RemoteDocument," then resolve the terminology choice and update both specifications consistently; completion means the revised wording no longer implies that references require network retrieval.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.