solid / solid/specification

Auxiliary resource type for configuration

Open
#178 1 comment 0 reactions 1 assignee View on GitHub

@justinwb is already working on this.

Since May 1, 2020.

topic: auxiliary resources
Dominant language
HTML
Stars
563
Forks
108
Avg merge
4d 13h
Merged PRs (30d)
3

Description

Creating this issue to track discussion and feedback for a new type of auxiliary resource - Configuration - which would be used to store configurable parameters for a given resource (which could also be inherited as part of a resource hierarchy when set on a container).

For example, whether to maintain Mementos for a given resource, or suggestions to the server about how data within a given resource might be indexed.

The rationale for a configuration auxiliary resource type is that a descriptive auxiliary resource is a catch-all to store anything that can annotate the directly associated solid resource, while a configuration auxiliary resource is meant to influence how servers may process the same, and so there may be good reason to have the configuration auxiliary resource be kept separately with stricter permissions than the descriptive auxiliary resource.

The configuration auxiliary resource type was originally included in the auxiliary resource candidate proposal, but was removed during editorial review until more use cases can be presented that justify the storage of configuration parameters in their own auxiliary resource requiring different permissions.

Related issues / comments / conversations:

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.