diff options
author | fr33domlover <fr33domlover@riseup.net> | 2019-07-26 10:54:42 +0300 |
---|---|---|
committer | fr33domlover <fr33domlover@riseup.net> | 2019-07-26 10:54:42 +0300 |
commit | 109ec9a09c7df7fec775d2ba0b9d466e5643ec8c (patch) | |
tree | f7847344360b9df3ed064356642cd650c391c18a | |
parent | 7fb1196a6e79713eb0ed4a73b1d86b405013ba47 (diff) |
Start section headers from h2, reserving h1 for the page title
-rw-r--r-- | specification/forgefed-vocabulary.md | 44 | ||||
-rw-r--r-- | specification/forgefed.md | 24 |
2 files changed, 34 insertions, 34 deletions
diff --git a/specification/forgefed-vocabulary.md b/specification/forgefed-vocabulary.md index 60a2f81..6b563de 100644 --- a/specification/forgefed-vocabulary.md +++ b/specification/forgefed-vocabulary.md @@ -17,14 +17,14 @@ title: ForgeFed Vocabulary 2019 ... -# Abstract +## Abstract This document describes the ForgeFed vocabulary. It's intended to be an extension of the [ActivityPub Vocabulary](https://www.w3.org/TR/activitystreams-vocabulary/) and provides additional vocabulary for federation of project management and version control system hosting and collaboration platforms. -# Introduction +## Introduction The ForgeFed Vocabulary describes a set of types and properties to be used by platforms that support the ForgeFed protocol. This specification describes only @@ -32,7 +32,7 @@ the new vocabulary called ForgeFed. The ForgeFed behavior specification describes how to use this vocabulary, along with standard ActivityPub vocabulary, to support the ForgeFed protocol. -# Types +## Types The base URI of all ForgeFed terms is `https://forgefed.peers.community/ns#`. The ForgeFed vocabulary has a JSON-LD context whose URI is @@ -51,9 +51,9 @@ A typical `@context` of a ForgeFed object may look like this: ] ``` -## Activity Types +### Activity Types -### Push +#### Push **URI:** `https://forgefed.peers.community/ns#Push` @@ -83,9 +83,9 @@ A Repository actor can use this Activity to notify followers of new changes. } ``` -## Actor Types +### Actor Types -### Repository +#### Repository **URI:** `https://forgefed.peers.community/ns#Repository` @@ -110,9 +110,9 @@ A Repository actor can use this Activity to notify followers of new changes. } ``` -## Object Types +### Object Types -### Commit +#### Commit **URI:** `https://forgefed.peers.community/ns#Commit` @@ -135,7 +135,7 @@ A Repository actor can use this Activity to notify followers of new changes. } ``` -### TicketDependency +#### TicketDependency **URI:** `https://forgefed.peers.community/ns#TicketDependency` @@ -165,7 +165,7 @@ be "dependsOn". } ``` -### Ticket +#### Ticket **URI:** `https://forgefed.peers.community/ns#Ticket` @@ -197,9 +197,9 @@ repository), and are used to track ideas, proposals, tasks, bugs and more. } ``` -# Properties +## Properties -## assignedTo +### assignedTo **URI:** `https://forgefed.peers.community/ns#assignedTo` @@ -215,7 +215,7 @@ repository), and are used to track ideas, proposals, tasks, bugs and more. **Example:** -## isResolved +### isResolved **URI:** `https://forgefed.peers.community/ns#isResolved` @@ -232,7 +232,7 @@ and it doesn't need to attract attention anymore. **Example:** -## dependsOn +### dependsOn **URI:** `https://forgefed.peers.community/ns#dependsOn` @@ -249,7 +249,7 @@ can't be resolved without those tickets being resolved too. **Example:** -## dependedBy +### dependedBy **URI:** `https://forgefed.peers.community/ns#dependedBy` @@ -266,7 +266,7 @@ they can't be resolved without this tickets being resolved too. **Example:** -## dependencies +### dependencies **URI:** `https://forgefed.peers.community/ns#dependencies` @@ -284,7 +284,7 @@ tickets that this ticket depends on, i.e. this ticket is the `subject` of the **Example:** -## dependants +### dependants **URI:** `https://forgefed.peers.community/ns#dependants` @@ -302,7 +302,7 @@ tickets that depends on this ticket, i.e. this ticket is the `object` of the **Example:** -## committedBy +### committedBy **URI:** `https://forgefed.peers.community/ns#committedBy` @@ -325,7 +325,7 @@ copy of the repository. **Example:** -## filesAdded +### filesAdded **URI:** `https://forgefed.peers.community/ns#filesAdded` @@ -343,7 +343,7 @@ didn't exist in the previous version of the tree. **Example:** -## filesModified +### filesModified **URI:** `https://forgefed.peers.community/ns#filesModified` @@ -361,7 +361,7 @@ of the tree, and its contents got modified in this commit. **Example:** -## filesRemoved +### filesRemoved **URI:** `https://forgefed.peers.community/ns#filesRemoved` diff --git a/specification/forgefed.md b/specification/forgefed.md index 1496b54..f98f881 100644 --- a/specification/forgefed.md +++ b/specification/forgefed.md @@ -17,7 +17,7 @@ title: ForgeFed 2019 ... -# Abstract +## Abstract This document describes the ForgeFed protocol. ForgeFed is an extension of the [ActivityPub](https://www.w3.org/TR/activitypub/) protocol for delivering @@ -26,20 +26,20 @@ The purpose of this specification is to describe a protocol that can be integrat into source code management for enabling collaboration across different platforms. -# Status of This Document +## Status of This Document -# Overview +## Overview ForgeFed is an extension of [ActivityPub](https://www.w3.org/TR/activitypub/) and follows the same "actors" model, with a client-to-server protocol and a server-to-server protocol. -# Conformance +## Conformance The key words MAY, MUST, MUST NOT, SHOULD, and SHOULD NOT are to be interpreted as described in [RFC2119]. -# Objects +## Objects Objects are the core concept around which both ActivityPub and ForgeFed are built. Examples of Objects are Note, Ticket, or Image. @@ -47,7 +47,7 @@ Objects are wrapped in Activities, a subtype of Object that describes some form of action that may happen, is currently happening, or has already happened. Examples of Activities are Create, Delete, or Follow. -# Actors +## Actors A ForgeFed implementation MUST provide an Actor of type `Repository` for every repository that should support federation. @@ -55,32 +55,32 @@ repository that should support federation. A ForgeFed implementation SHOULD provide an Actor of type `Person` for every user of the platform. -# Client to Server Interactions +## Client to Server Interactions ForgeFed uses Activities for client to server interactions, as described by ActivityPub. A client will send objects (eg. a Ticket) wrapped in a Activity (eg. Create) to an actor's outbox, and in turn the server will take care of delivery. -## Follow Activity +### Follow Activity The Follow activity is used to subscribe to the activities of a Repository. The client MUST send a Follow activity the a Person's outbox. The server in turn delivers the message to the destination inbox. -## Push Activity +### Push Activity The Push activity is used to notify followers when somebody has pushed changes to a Repository. The client MUST send a Push activity the a Repository's outbox. The server in turn delivers the message to the Repository followers. -# Server to Server Interactions +## Server to Server Interactions -## Follow Activity +### Follow Activity The server receiving a Follow activity in a Repository's inbox SHOULD add the sender actor to the Repository's followers collection. -# Acknowledgements +## Acknowledgements |