Skip to content

Commit

Permalink
Merge pull request #107 from solid/chore/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
VirginiaBalseiro authored Sep 28, 2023
2 parents b28a7ab + 5e2a9c2 commit e3fae66
Showing 1 changed file with 17 additions and 57 deletions.
74 changes: 17 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,10 @@
# Discovery based on Solid Social Agent WebID
# Solid WebID Profile

[![Join the chat at https://gitter.im/solid/webid-profile](https://badges.gitter.im/solid/webid-profile.svg)](https://gitter.im/solid/webid-profile?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This repository holds materials related to the proposed specification see the [HTML Version of the Spec](https://solid.github.io/webid-profile/).

The Type Indexes split of in its own repo [here](https://github.com/solid/type-indexes).
This repository holds materials related to the proposed Solid WebID Profile specification.

## Overview

When an app allows a user to log in to a Solid Identity Provider, the app receives back data that establishes the identity of the user in terms of a WebID URI. An app can also obtain a WebID URI through input from a user or by parsing documents that contain the URI. The general purpose of this document is to describe what an app can discover based on the WebID. More specific purposes are described below.

A Social Agent - a person, group, or organization - may own one or more WebIDs. Each WebID is a URI that can be dereferenced to point to exactly one document, hereafter called a `WebID document`. The term 'WebID document', will be used here to refer only to a `Social Agent WebID Document`. WebID documents, in general, can be for software or other kinds of Agents but, in this document, it will only apply to WebID documents associated with Social Agents.

WebID documents may optionally point, through various means, to other documents whose intent is to identify the WebID owner and/or describe details about their data. These other documents, whatever predicates are used to indicate them, and however they are named, will be referred to collectively as `extended profile documents`.

The term `profile` will be used here to refer to the data that can be gathered in the WebID document and all extended profile documents it points to.

## Structure of document

Profiles contain two major types of information: 1) identifiying information such as a person or organization's name, purpose, contacts, etc. and 2) infrastructure information such as what types of data the user has, where it is stored, and who has access to it.
This document and the [Type Indexes](https://github.com/solid/type-indexes) document will focus on the latter - the information that an app can use to learn how to interact with the data associated with the Social Agent's WebID.

This repo will eventually contain three documents -
1) this one on infrastructure discovery,
2) one on personal profile information,
3) and one on organizational profiles.

These may be combined into a single or more documents in the future.
The [Solid WebID Profile specification](https://solid.github.io/webid-profile/) describes the discovery process and data model of a Solid Profile, representing a social agent's identity within various usage scenarios and application-specific preferences.

## Goals

Expand All @@ -35,51 +13,33 @@ The goals of this group are:
* to define a data model to express identities within a social, conceptual, and contextual relations in order enable socially-aware decentralised applications.
* to make recommendations and guidelines based on adequate implementation experience, as well as a framework for specialisation and extension of existing specifications.

## Content addressed

There is great variability in what information is found in the profile and which documents the information is stored in. The [interoperability panel](https://solid.github.io/data-interoperability-panel/specification/) is in the process of developing alternative discovery processes. So, there can be more than one discovery process. This specification aims to **describe the discovery process as it is currently in use**.

To sum up, this document aims to cover
## Background

* Social Agents, not Software Agents
* WebID documents and extended profile documents
* Discovery of data structures, not personal/group identifying information
* Current practices, not future specifications
* [Solid WebID Profiles](https://github.com/solid/solid-spec/blob/master/solid-webid-profiles.md)
* [Applications Discovery](https://github.com/solid/solid/blob/main/proposals/data-discovery.md)
* [Original Interop Issue](https://github.com/solid/data-interoperability-panel/issues/209)
* [WebID Draft Specification](https://www.w3.org/2005/Incubator/webid/spec/identity/)
* [Universal Identity for the Web](https://csarven.ca/linked-research-decentralised-web#universal-identity-for-the-web)

The following predicates will be the main foucs of the documention :
## Related Work Ttems

- [ ] foaf:primaryTopic
- [ ] foaf:isPrimaryTopicOf
- [ ] solid:oidcIssuer
- [ ] solid:account (have not yet found anyone using this, maybe omit?)
- [ ] solid:publicTypeIndex -> moved to its own Type Indexes repo [here](https://github.com/solid/type-indexes)
- [ ] solid:privateTypeIndex -> moved to its own Type Indexes repo [here](https://github.com/solid/type-indexes)
- [ ] pim:storage
- [ ] pim:preferencesFile
- [ ] acl:trustedApp (possibly omit this for this spec?)
- [ ] owl:sameAs
- [ ] rdfs:seeAlso

## Related Resources
* [Minutes of meetings](https://github.com/solid/webid-profile/tree/main/meetings)
* NEW [Type Indexes repo](https://github.com/solid/type-indexes)
* Prior work : [Solid WebID Profiles](https://github.com/solid/solid-spec/blob/master/solid-webid-profiles.md)
* Prior work : [Applications Discovery](https://github.com/solid/solid/blob/main/proposals/data-discovery.md)
* Prior work : [Original Interop Issue](https://github.com/solid/data-interoperability-panel/issues/209)
* Prior work : [WebID Draft Specification](https://www.w3.org/2005/Incubator/webid/spec/identity/)
* Prior work : [Universal Identity for the Web](https://csarven.ca/linked-research-decentralised-web#universal-identity-for-the-web)
* [Type Indexes repo](https://github.com/solid/type-indexes)

## Team

* Virginia Balseiro
* Tim Berners-Lee
* Sarven Capadisli
* Timea Turdean
* Jeff Zucker

## Participation

All contributors to any Work Items must be members of the Solid CG. It’s easy to [join the CG](https://www.w3.org/community/solid/join).

Anyone can join the [Solid WebID Profile chat](https://matrix.to/#/#solid_webid-profile:gitter.im), or propose a topic for discussion during the weekly [Solid Community Group meetings](https://github.com/solid/specification/#participation).
Anyone can join the [Solid WebID Profile chat](https://matrix.to/#/#solid_webid-profile:gitter.im), or propose a topic for discussion during the weekly [Solid Community Group meetings](https://github.com/solid/specification/#participation). The chat is also used to coordinate and communicate concrete meeting plans and agendas.

A **tentative** meeting slot is held open on Mondays, 15:00 UTC at https://meet.jit.si/solid-profile. Please refer to the [chat](https://gitter.im/solid/webid-profile) for concrete meeting plans and agendas. Meetings are transcribed and [published](https://github.com/solid/webid-profile/tree/main/meetings/).
A **tentative** meeting slot is held open on Mondays, 15:00 UTC at https://meet.jit.si/solid-profile. Meetings are transcribed and [published](https://github.com/solid/webid-profile/tree/main/meetings/).

## Code of Conduct

Expand Down

0 comments on commit e3fae66

Please sign in to comment.