From fc9d0964392f2c7a083c154a68a093471db867eb Mon Sep 17 00:00:00 2001 From: bill-auger Date: Apr 27 2019 04:58:09 +0000 Subject: update README --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..beaa8dd --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +* +!.gitignore +!COPYING +!README.md + +!doc +doc/* +!doc/README.md + +!vocabulary/ +!vocabulary/* +!vocabulary/COMMENT.md +!vocabulary/ISSUE.md +!vocabulary/PULL-REQUEST.md +!vocabulary/README.md +!vocabulary/REPOSITORY.md +!vocabulary/VOCABULARY.md diff --git a/README.md b/README.md index a9a2de6..4d6996c 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,27 @@ -# ForgeFed - Work-group for Federated Forge Services +# ForgeFed - Federation Protocol for Forge Services -ForgeFed is a federation protocol extending the W3C's [ActivityPub][activity-pub] protocol to provide a uniform server-to-server API for interoperability between networked version control services, with limited Pub/Sub access for messaging and notifications to and from the larger Fediverse. It allows users of any compliant service to interact with other compliant forge services without being a registered user of that foreign service, just as if they were. In this way, users that choose to self-host have the additional benefit/responsibility of being in full control of their own authentication/identity and their own data. +ForgeFed is a federation protocol extending the W3C's [ActivityPub][activity-pub] protocol to provide a uniform server-to-server API for interoperability between networked version control services, with limited pub/sub access for messaging and notifications to and from the larger fediverse. It allows users of any ForgeFed-compliant service to interact with other ForgeFed-compliant forge services, without being a registered user of that foreign service, just as if they were. In this way, users that choose to self-host have the additional benefit/responsibility of fully controlling of their own authentication/identity and their own data. -All of the most common user interactions are supported such as: cloning/forking, merge-requests/patches, bug-reports/code-review, subscriptions/favorites with VCS-agnostic and service-agnostic genericity. +All of the most common user interactions are supported such as: cloning/forking, merge-requests/patches, bug-reports/code-review, subscriptions/favorites with VCS-agnostic, service-agnostic, and client-agnostic genericity. -## Collaboration +## Work-group Collaboration -The formal work-group discussions and decision making are conducted on our mailing list, and is limited to members of the work-group. However, the [discussions are publicly readable][mail-archive] via the web. Everyone else is encouraged to participate using the issue trackers and wikis on either of our public repositories on [GitHub][github-issues] or [NotABug][notabug-issues], or by sending email to the [mailing list][mailing-list]. Note that the mailing list is moderated for non-members; so there could be some delay posting it. +The formal work-group and associated development discussions are conducted openly on the [ForgeFed Community Forum][socialhub-forum] on the socialhub.network website; with informal, real-time Collaboration often taking place on the #peers IRC channel on freenode. Everyone is invited to participate in either venue. Before posting, please read [this primer][overview] for a brief overview of the project motivation and goals. -The artifacts produced by this work-group are still in the early stages; and there is still much work to do and ample room for discussion. In order to be most widely adopted, we strive to assemble the most diverse and representative discussion group of stake-holders including: users, implementors, and various domain experts. Anyone who is experienced with working on an existing forge or federated "social" service, or who is planning to implement new ones, and anyone with experience in writing technical specification documents, or has UX expertise is encouraged to join the work-group. Just send an email to the [mailing list][mailing-list] stating that you would like to join the work-group and how your experience could complement the project. +The artifacts produced by this work-group are still in the early stages; and there is still much work to do, and ample design-space for discussion and contributions. In order to be most widely adopted, we strive to assemble the most diverse and representative group of stake-holders including: users, implementers, and various domain experts. Anyone who is experienced with working on an existing forge or a federated "social" service, or who is planning to implement new ones, and anyone with experience in writing technical specification documents, or has UX expertise is encouraged to join the work-group and/or contribute artifacts. Please submit any tangible contributions (artwork, software, documentation) and technical critique regarding the published artifacts to the [ForgeFed issue tracker][notabug-issues] and [ForgeFed wiki][notabug-wiki] on NotABug, or the [ForgeFed mirror on Pagure][pagure-mirror]. -Services currently represented in the discussions: +### Projects participating in the discussions have included: + +* [Federated Networks Association][feneas] * [Git-Dit][git-dit] * [GitLab][gitlab] * [GitTea][gittea] * [Gogs][gogs] +* [NotABug][notabug] * [Pagure][pagure] +* [Peers Community][peers] * [SocialHome][socialhome] * [sr.ht][srht] * [Vervis][vervis] @@ -25,20 +29,28 @@ Services currently represented in the discussions: ## License -All artifacts produced by this work-group are freely available under the [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc0]. All contributions to the wiki must also be offered freely as such. - - -[activity-pub]: https://www.w3.org/TR/activitypub/ -[mailing-list]: mailto://git-federation@framalistes.org -[mail-archive]: https://framalistes.org/sympa/arc/git-federation -[github-issues]: https://github.com/forgefed/forgefed/issues -[notabug-issues]: https://notabug.org/peers/forgefed/issues -[cc0]: https://creativecommons.org/publicdomain/zero/1.0/ -[git-dit]: https://github.com/neithernut/git-dit -[gitlab]: https://about.gitlab.com/ -[gittea]: https://gitea.io/en-us/ -[gogs]: https://gogs.io/ -[pagure]: https://pagure.io/ -[socialhome]: https://socialhome.network/ -[srht]: https://meta.sr.ht/ -[vervis]: https://dev.angeley.es/s/fr33domlover/p/vervis +All artifacts produced by the ForgeFed work-group are freely available under the [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc0]. All contributions to the wiki must also be offered freely as such. + + +[activity-pub]: https://www.w3.org/TR/activitypub/ +[mail-archive]: https://framalistes.org/sympa/arc/git-federation +[feneas]: https://feneas.org +[socialhub]: https://socialhub.network/ +[vervis]: https://dev.angeley.es/s/fr33domlover/r/vervis +[notabug-repo]: https://notabug.org/peers/forgefed/ +[socialhub-forum]: https://socialhub.network/c/forgefed +[overview]: https://notabug.org/peers/forgefed/src/master/doc/README.md +[notabug-issues]: https://notabug.org/peers/forgefed/issues +[notabug-wiki]: https://notabug.org/peers/forgefed/wiki +[pagure-mirror]: https://pagure.io/forge-fed/forge-fed +[git-dit]: https://github.com/neithernut/git-dit +[gitlab]: https://about.gitlab.com/ +[gittea]: https://gitea.io/en-us/ +[go-fed]: http://go-fed.org/ +[gogs]: https://gogs.io/ +[notabug]: https://notabug.org/ +[pagure]: https://pagure.io/ +[peers]: https://peers.community/ +[socialhome]: https://socialhome.network/ +[srht]: https://meta.sr.ht/ +[cc0]: https://creativecommons.org/publicdomain/zero/1.0/