solid / solid/specification

Guidelines for publishing, discovering and using URI Persistence policies

Open
#206 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

doc: Best Practices doc: Protocol
Dominant language
HTML
Stars
563
Forks
108
Avg merge
4d 13h
Merged PRs (30d)
3

Description

As per https://www.w3.org/TR/webarch/#URI-persistence

URI persistence is a matter of policy and commitment on the part of the URI owner.

Going forward, it would be in the interest of Solid servers - pods - to make their URI Persistence policy available as Linked Data. Applications can discover these policies and bring them to the attention of their users eg. bringing the policy to the forefront before committing to any action, like creating a pod or any resource within, as well as automate decisions on behalf of their users' based on their preferences.

Typically they describe the following:

  • a pledge towards the longevity and accessibility of the URIs;
  • what happens to the URIs once the owner ceases to exist or owners are changed.

The Solid Ecosystem or possibly the Best Practices and Guidelines document can cover this.

Policies can be expressed in different ways to suit each site's / URI owners' pledge. Here is a famous persistence policy from W3C: https://www.w3.org/Consortium/Persistence

Another example discoverable from https://csarven.ca/ and available in RDF:

<https://csarven.ca/>
  <http://www.w3.org/2000/10/swap/pim/doc#persistencePolicy> <https://csarven.ca/about#persistence-policy> .

<https://csarven.ca/about#persistence-policy>
  <http://schema.org/name> "URI Persistence Policy"@en ;
  <http://schema.org/description> "..." .

The persistence policy resource can of course be extended in any creative and useful way eg. including relevant provenance record (perhaps with PROV-O).

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

Start with the linked W3C URI Persistence reference, then review the proposed Linked Data example and the Solid Best Practices and Guidelines document mentioned in the issue. Define what a Solid server's persistence policy should disclose, how applications can discover it, and where the guidance belongs; done means the policy guidance and examples are documented and agreed.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.