From d7f6d0740f6685d1aaeba3141ebee9a74547101d Mon Sep 17 00:00:00 2001 From: AvidSeeker Date: Thu, 18 Jul 2024 16:54:11 +0000 Subject: [PATCH] FEP-c893: DOAP (#369) Standardized method for describing Fediverse projects using the [Description of a Project (DOAP) format](https://github.com/ewilderj/doap/wiki). Related FEPs: * FEP-67ff: [FEDERATION.md](https://codeberg.org/fediverse/fep/src/branch/main/fep/67ff/fep-67ff.md) * FEP-f1d5: [NodeInfo](https://codeberg.org/fediverse/fep/src/branch/main/fep/f1d5/fep-f1d5.md) * XMPP has an XEP for this [XEP-0453](https://xmpp.org/extensions/xep-0453.html). [Discussion](https://socialhub.activitypub.rocks/t/4363) Reviewed-on: https://codeberg.org/fediverse/fep/pulls/369 Co-authored-by: AvidSeeker Co-committed-by: AvidSeeker --- fep/c893/fep-c893.md | 107 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 fep/c893/fep-c893.md diff --git a/fep/c893/fep-c893.md b/fep/c893/fep-c893.md new file mode 100644 index 0000000..4106041 --- /dev/null +++ b/fep/c893/fep-c893.md @@ -0,0 +1,107 @@ +--- +slug: "c893" +authors: AvidSeeker +status: DRAFT +dateReceived: 2024-07-15 +trackingIssue: '' +discussionsTo: 'https://socialhub.activitypub.rocks/t/fep-c893-doap/4363' +title: DOAP +--- + +# FEP-c893: DOAP + +## Summary + +This proposal introduces a standardized method for describing Fediverse projects +using the Description of a Project (DOAP) format. The proposal outlines the +creation of `doap.jsonld` file that includes details about implemented +federation protocols and supported Fediverse Enhancement Proposals (FEPs). This +makes it easier for developers and users to understand the capabilities and +compatibility of various Fediverse projects. + +### Example `doap.jsonld` File + +Here is an example structure for the `doap.jsonld` file: + +```json +{ + "@context": { + "doap": "http://usefulinc.com/ns/doap#", + "foaf": "http://xmlns.com/foaf/0.1/", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "doap:description": { + "@id": "doap:description", + "@container": "@language" + }, + "doap:shortdesc": { + "@id": "doap:shortdesc", + "@container": "@language" + } + }, + "@type": "doap:Project", + "doap:name": "ExampleProject", + "doap:homepage": "https://example.org", + "doap:description": { + "en": "ExampleProject is a Fediverse client/server that supports multiple protocols and enhancements.", + "es": "ExampleProject es un cliente/servidor de Fediverse que admite mĂșltiples protocolos y mejoras." + }, + "doap:shortdesc": { + "en": "Tools and vocabulary for describing community-based software projects.", + "es": "Vocabulario y herramientas para describir proyectos de software comunitarios." + }, + "doap:created": "2022-01-01", + "doap:logo": "https://example.org/logo.png", + "doap:screenshots": [ + "https://example.org/screenshot1.png", + "https://example.org/screenshot2.png" + ], + "doap:category": [ + "http://software.freshmeat.net/browse/1020/", + "http://osdir.com/Downloads+index-req-viewsdownload-sid-201.phtml" + ], + "doap:repository": { + "@type": "doap:GitRepository", + "doap:browse": "https://github.com/example/exampleproject/", + "doap:location": "https://github.com/example/exampleproject.git" + }, + "doap:release": { + "@type": "doap:Version", + "doap:created": "2024-07-15", + "doap:name": "v1.0.0", + "doap:revision": "1.0.0" + }, + "doap:maintainer": [ + { + "@type": "foaf:Person", + "foaf:name": "John Doe", + "foaf:homepage": "https://github.com/johndoe" + }, + { + "@type": "foaf:Person", + "foaf:name": "Jane Smith", + "foaf:homepage": "https://github.com/janesmith" + } + ], + "doap:implements": [ + "https://activitypub.rocks/specification", + "https://diasporafoundation.org" + ], + "doap:supportedFEPs": [ + "https://fediverse.org/fep-0001", + "https://fediverse.org/fep-0002" + ] +} +``` + +## References + +- [Description of a Project (DOAP) Specification](http://usefulinc.com/ns/doap#) +- [XEP-0453: DOAP Usage in XMPP](https://xmpp.org/extensions/xep-0453.html) + +## Copyright + +CC0 1.0 Universal (CC0 1.0) Public Domain Dedication + +To the extent possible under law, the authors of this Fediverse Enhancement +Proposal have waived all copyright and related or neighboring rights to this +work.