diff options
| author | fr33domlover <fr33domlover@riseup.net> | 2019-07-23 13:29:45 +0300 |
|---|---|---|
| committer | fr33domlover <fr33domlover@riseup.net> | 2019-07-23 13:29:45 +0300 |
| commit | 28ce77c58fac2e738c8744f87e11ff540d433a29 (patch) | |
| tree | c48f9795bee5c4bee75f3b5248be88c051b59bbe | |
| parent | b512bd569f1a8b01526ac25a92e5b328a7cb2651 (diff) | |
Edit template footer, add CC0 notice
| -rw-r--r-- | html/forgefed-vocabulary.html | 209 | ||||
| -rw-r--r-- | html/forgefed.html | 45 | ||||
| -rw-r--r-- | html/index.html | 25 | ||||
| -rw-r--r-- | html/template.html | 25 | ||||
| -rw-r--r-- | html/theme.css | 5 |
5 files changed, 191 insertions, 118 deletions
diff --git a/html/forgefed-vocabulary.html b/html/forgefed-vocabulary.html index 9ab012e..f21f3c1 100644 --- a/html/forgefed-vocabulary.html +++ b/html/forgefed-vocabulary.html @@ -28,9 +28,9 @@ </header> <main class="main"> <h1 class="main-title"> - ForgeFed Vocabulary - draft - 2019-07-21 master - <a href="https://notabug.org/peers/forgefed/commit/f7d66c9ca691e3edaacd115e03bcdf287f720576"> - f7d66c9 + ForgeFed Vocabulary - draft - 2019-07-23 master + <a href="https://notabug.org/peers/forgefed/commit/b512bd569f1a8b01526ac25a92e5b328a7cb2651"> + b512bd5 </a> [dirty] </h1> @@ -69,123 +69,123 @@ <li>deesix</li> <li>fr33domlover</li> <li>zPlus</li> - <li>... add other editors</li> + <li>… add other editors</li> </ul> <p><strong>Repository:</strong></p> <ul> <li><a href="https://notabug.org/peers/forgefed">NotABug</a></li> </ul> <p><strong>Copyright:</strong></p> - <p>2019 ...</p> + <p>2019 …</p> <h1 id="abstract"><span class="header-section-number">1</span> Abstract</h1> - <p>This document describes the ForgeFed vocabulary. It's intended to be an extension of the <a href="https://www.w3.org/TR/activitystreams-vocabulary/">ActivityPub Vocabulary</a> and provides additional vocabulary for federation of project management and version control system hosting and collaboration platforms.</p> + <p>This document describes the ForgeFed vocabulary. It’s intended to be an extension of the <a href="https://www.w3.org/TR/activitystreams-vocabulary/">ActivityPub Vocabulary</a> and provides additional vocabulary for federation of project management and version control system hosting and collaboration platforms.</p> <h1 id="introduction"><span class="header-section-number">2</span> Introduction</h1> <p>The ForgeFed Vocabulary describes a set of types and properties to be used by platforms that support the ForgeFed protocol. This specification describes only 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.</p> <h1 id="types"><span class="header-section-number">3</span> Types</h1> <p>The base URI of all ForgeFed terms is <code>https://forgefed.peers.community/ns#</code>. The ForgeFed vocabulary has a JSON-LD context whose URI is <code>https://forgefed.peers.community/ns</code>. Implementers MUST either include the ActivityPub and ForgeFed contexts in their object definitions, or other contexts that would result with the ActivityPub and ForgeFed terms being assigned they correct full URIs. Implementers MAY include additional contexts and terms as appropriate.</p> <p>A typical <code>@context</code> of a ForgeFed object may look like this:</p> - <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="er">"@context":</span> <span class="ot">[</span> - <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span> - <span class="st">"https://forgefed.peers.community/ns"</span> - <span class="ot">]</span></code></pre></div> + <div class="sourceCode" id="cb1"><pre class="sourceCode json"><code class="sourceCode json"><a class="sourceLine" id="cb1-1" title="1"><span class="er">"@context":</span> <span class="ot">[</span></a> + <a class="sourceLine" id="cb1-2" title="2"> <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span></a> + <a class="sourceLine" id="cb1-3" title="3"> <span class="st">"https://forgefed.peers.community/ns"</span></a> + <a class="sourceLine" id="cb1-4" title="4"><span class="ot">]</span></a></code></pre></div> <h2 id="activity-types"><span class="header-section-number">3.1</span> Activity Types</h2> <h3 id="push"><span class="header-section-number">3.1.1</span> Push</h3> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#Push</code></p> - <p><strong>Notes:</strong> Indicates that new content has been pushed to the repository. The Activity's object MUST contain a list of Commits. A Repository actor can use this Activity to notify followers of new changes.</p> + <p><strong>Notes:</strong> Indicates that new content has been pushed to the repository. The Activity’s object MUST contain a list of Commits. A Repository actor can use this Activity to notify followers of new changes.</p> <p><strong>Example:</strong></p> - <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="fu">{</span> - <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span> - <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span> - <span class="st">"https://forgefed.peers.community/ns"</span> - <span class="ot">]</span><span class="fu">,</span> - <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"Alice pushed 2 new commits to Repo2."</span> - <span class="st">"type"</span><span class="er">:</span> <span class="st">"Push"</span><span class="fu">,</span> - <span class="dt">"actor"</span><span class="fu">:</span> <span class="st">"https://localhost/alice/repo2"</span><span class="fu">,</span> - <span class="dt">"object"</span><span class="fu">:</span> <span class="ot">[</span> - <span class="fu">{</span> - <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span> - <span class="fu">}</span><span class="ot">,</span> - <span class="fu">{</span> - <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span> - <span class="fu">}</span> - <span class="ot">]</span> - <span class="fu">}</span></code></pre></div> + <div class="sourceCode" id="cb2"><pre class="sourceCode json"><code class="sourceCode json"><a class="sourceLine" id="cb2-1" title="1"><span class="fu">{</span></a> + <a class="sourceLine" id="cb2-2" title="2"> <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span></a> + <a class="sourceLine" id="cb2-3" title="3"> <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span></a> + <a class="sourceLine" id="cb2-4" title="4"> <span class="st">"https://forgefed.peers.community/ns"</span></a> + <a class="sourceLine" id="cb2-5" title="5"> <span class="ot">]</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb2-6" title="6"> <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"Alice pushed 2 new commits to Repo2."</span></a> + <a class="sourceLine" id="cb2-7" title="7"> <span class="st">"type"</span><span class="er">:</span> <span class="st">"Push"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb2-8" title="8"> <span class="dt">"actor"</span><span class="fu">:</span> <span class="st">"https://localhost/alice/repo2"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb2-9" title="9"> <span class="dt">"object"</span><span class="fu">:</span> <span class="ot">[</span></a> + <a class="sourceLine" id="cb2-10" title="10"> <span class="fu">{</span></a> + <a class="sourceLine" id="cb2-11" title="11"> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb2-12" title="12"> <span class="fu">}</span><span class="ot">,</span></a> + <a class="sourceLine" id="cb2-13" title="13"> <span class="fu">{</span></a> + <a class="sourceLine" id="cb2-14" title="14"> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb2-15" title="15"> <span class="fu">}</span></a> + <a class="sourceLine" id="cb2-16" title="16"> <span class="ot">]</span></a> + <a class="sourceLine" id="cb2-17" title="17"><span class="fu">}</span></a></code></pre></div> <h2 id="actor-types"><span class="header-section-number">3.2</span> Actor Types</h2> <h3 id="repository"><span class="header-section-number">3.2.1</span> Repository</h3> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#Repository</code></p> <p><strong>Notes:</strong> Represents a version control system repository.</p> <p><strong>Example:</strong></p> - <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="fu">{</span> - <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span> - <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span> - <span class="st">"https://forgefed.peers.community/ns"</span> - <span class="ot">]</span><span class="fu">,</span> - <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://localhost/alice/forgefed"</span><span class="fu">,</span> - <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Repository"</span><span class="fu">,</span> - <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"ForgeFed"</span><span class="fu">,</span> - <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"ForgeFed development"</span><span class="fu">,</span> - <span class="dt">"inbox"</span><span class="fu">:</span> <span class="st">""</span><span class="fu">,</span> - <span class="dt">"outbox"</span><span class="fu">:</span> <span class="st">""</span><span class="fu">,</span> - <span class="dt">"followers"</span><span class="fu">:</span> <span class="st">""</span><span class="fu">,</span> - <span class="dt">"following"</span><span class="fu">:</span> <span class="st">""</span> - <span class="fu">}</span></code></pre></div> + <div class="sourceCode" id="cb3"><pre class="sourceCode json"><code class="sourceCode json"><a class="sourceLine" id="cb3-1" title="1"><span class="fu">{</span></a> + <a class="sourceLine" id="cb3-2" title="2"> <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span></a> + <a class="sourceLine" id="cb3-3" title="3"> <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span></a> + <a class="sourceLine" id="cb3-4" title="4"> <span class="st">"https://forgefed.peers.community/ns"</span></a> + <a class="sourceLine" id="cb3-5" title="5"> <span class="ot">]</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-6" title="6"> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://localhost/alice/forgefed"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-7" title="7"> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Repository"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-8" title="8"> <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"ForgeFed"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-9" title="9"> <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"ForgeFed development"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-10" title="10"> <span class="dt">"inbox"</span><span class="fu">:</span> <span class="st">""</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-11" title="11"> <span class="dt">"outbox"</span><span class="fu">:</span> <span class="st">""</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-12" title="12"> <span class="dt">"followers"</span><span class="fu">:</span> <span class="st">""</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb3-13" title="13"> <span class="dt">"following"</span><span class="fu">:</span> <span class="st">""</span></a> + <a class="sourceLine" id="cb3-14" title="14"><span class="fu">}</span></a></code></pre></div> <h2 id="object-types"><span class="header-section-number">3.3</span> Object Types</h2> <h3 id="commit"><span class="header-section-number">3.3.1</span> Commit</h3> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#Commit</code></p> - <p><strong>Notes:</strong> Represents a named set of changes to a repository. This is called "commit" in Git, Mercurial and Monotone; "patch" in Darcs; sometimes called "change set".</p> + <p><strong>Notes:</strong> Represents a named set of changes to a repository. This is called “commit” in Git, Mercurial and Monotone; “patch” in Darcs; sometimes called “change set”.</p> <p><strong>Example:</strong></p> - <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="fu">{</span> - <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span> - <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span> - <span class="st">"https://forgefed.peers.community/ns"</span> - <span class="ot">]</span><span class="fu">,</span> - <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span> - <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo/commit/2c7323781aec1f7"</span><span class="fu">,</span> - <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span> - <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"Add an installation script, fixes issue #89"</span> - <span class="fu">}</span></code></pre></div> + <div class="sourceCode" id="cb4"><pre class="sourceCode json"><code class="sourceCode json"><a class="sourceLine" id="cb4-1" title="1"><span class="fu">{</span></a> + <a class="sourceLine" id="cb4-2" title="2"> <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span></a> + <a class="sourceLine" id="cb4-3" title="3"> <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span></a> + <a class="sourceLine" id="cb4-4" title="4"> <span class="st">"https://forgefed.peers.community/ns"</span></a> + <a class="sourceLine" id="cb4-5" title="5"> <span class="ot">]</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-6" title="6"> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-7" title="7"> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo/commit/2c7323781aec1f7"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-8" title="8"> <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-9" title="9"> <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"Add an installation script, fixes issue #89"</span></a> + <a class="sourceLine" id="cb4-10" title="10"><span class="fu">}</span></a></code></pre></div> <h3 id="ticketdependency"><span class="header-section-number">3.3.2</span> TicketDependency</h3> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#TicketDependency</code></p> - <p><strong>Notes:</strong> Represents a relationship between 2 tickets, in which the resolution of one ticket requires the other ticket to be resolved too. It MUST specify the subject, object and relationship properties, and the relationship property MUST be "dependsOn".</p> + <p><strong>Notes:</strong> Represents a relationship between 2 tickets, in which the resolution of one ticket requires the other ticket to be resolved too. It MUST specify the subject, object and relationship properties, and the relationship property MUST be “dependsOn”.</p> <p><strong>Extends:</strong> <code>Relationship</code></p> <p><strong>Example:</strong></p> - <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="fu">{</span> - <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span> - <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span> - <span class="st">"https://forgefed.peers.community/ns"</span> - <span class="ot">]</span><span class="fu">,</span> - <span class="dt">"type"</span><span class="fu">:</span> <span class="ot">[</span><span class="st">"Relationship"</span><span class="ot">,</span> <span class="st">"TicketDependency"</span><span class="ot">]</span><span class="fu">,</span> - <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/ticket-deps/2342593"</span><span class="fu">,</span> - <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span> - <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"Alice's ticket depends on Bob's ticket"</span><span class="fu">,</span> - <span class="dt">"published"</span><span class="fu">:</span> <span class="st">"2019-07-11T12:34:56Z"</span><span class="fu">,</span> - <span class="dt">"subject"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myproj/issues/42"</span><span class="fu">,</span> - <span class="dt">"relationship"</span><span class="fu">:</span> <span class="st">"dependsOn"</span><span class="fu">,</span> - <span class="dt">"object"</span><span class="fu">:</span> <span class="st">"https://dev.community/bob/coolproj/issues/85"</span> - <span class="fu">}</span></code></pre></div> + <div class="sourceCode" id="cb5"><pre class="sourceCode json"><code class="sourceCode json"><a class="sourceLine" id="cb5-1" title="1"><span class="fu">{</span></a> + <a class="sourceLine" id="cb5-2" title="2"> <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span></a> + <a class="sourceLine" id="cb5-3" title="3"> <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span></a> + <a class="sourceLine" id="cb5-4" title="4"> <span class="st">"https://forgefed.peers.community/ns"</span></a> + <a class="sourceLine" id="cb5-5" title="5"> <span class="ot">]</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-6" title="6"> <span class="dt">"type"</span><span class="fu">:</span> <span class="ot">[</span><span class="st">"Relationship"</span><span class="ot">,</span> <span class="st">"TicketDependency"</span><span class="ot">]</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-7" title="7"> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/ticket-deps/2342593"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-8" title="8"> <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-9" title="9"> <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"Alice's ticket depends on Bob's ticket"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-10" title="10"> <span class="dt">"published"</span><span class="fu">:</span> <span class="st">"2019-07-11T12:34:56Z"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-11" title="11"> <span class="dt">"subject"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myproj/issues/42"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-12" title="12"> <span class="dt">"relationship"</span><span class="fu">:</span> <span class="st">"dependsOn"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb5-13" title="13"> <span class="dt">"object"</span><span class="fu">:</span> <span class="st">"https://dev.community/bob/coolproj/issues/85"</span></a> + <a class="sourceLine" id="cb5-14" title="14"><span class="fu">}</span></a></code></pre></div> <h3 id="ticket"><span class="header-section-number">3.3.3</span> Ticket</h3> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#Ticket</code></p> <p><strong>Notes:</strong> Represents an item that requires work or attention. Tickets exist in the context of a project (which may or may not be a version-control repository), and are used to track ideas, proposals, tasks, bugs and more.</p> <p><strong>Example:</strong></p> - <div class="sourceCode"><pre class="sourceCode json"><code class="sourceCode json"><span class="fu">{</span> - <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span> - <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span> - <span class="st">"https://forgefed.peers.community/ns"</span> - <span class="ot">]</span><span class="fu">,</span> - <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Ticket"</span><span class="fu">,</span> - <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo/issues/42"</span><span class="fu">,</span> - <span class="dt">"context"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo"</span><span class="fu">,</span> - <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://dev.community/bob"</span><span class="fu">,</span> - <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"Nothing works!"</span><span class="fu">,</span> - <span class="dt">"content"</span><span class="fu">:</span> <span class="st">"<p>Please fix. <i>Everything</i> is broken!</p>"</span><span class="fu">,</span> - <span class="dt">"mediaType"</span><span class="fu">:</span> <span class="st">"text/html"</span><span class="fu">,</span> - <span class="dt">"source"</span><span class="fu">:</span> <span class="fu">{</span> - <span class="dt">"content"</span><span class="fu">:</span> <span class="st">"Please fix. *Everything* is broken!"</span><span class="fu">,</span> - <span class="dt">"mediaType"</span><span class="fu">:</span> <span class="st">"text/markdown; variant=CommonMark"</span> - <span class="fu">},</span> - <span class="dt">"assignedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span> - <span class="dt">"isResolved"</span><span class="fu">:</span> <span class="kw">false</span> - <span class="fu">}</span></code></pre></div> + <div class="sourceCode" id="cb6"><pre class="sourceCode json"><code class="sourceCode json"><a class="sourceLine" id="cb6-1" title="1"><span class="fu">{</span></a> + <a class="sourceLine" id="cb6-2" title="2"> <span class="dt">"@context"</span><span class="fu">:</span> <span class="ot">[</span></a> + <a class="sourceLine" id="cb6-3" title="3"> <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span></a> + <a class="sourceLine" id="cb6-4" title="4"> <span class="st">"https://forgefed.peers.community/ns"</span></a> + <a class="sourceLine" id="cb6-5" title="5"> <span class="ot">]</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-6" title="6"> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Ticket"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-7" title="7"> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo/issues/42"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-8" title="8"> <span class="dt">"context"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-9" title="9"> <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://dev.community/bob"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-10" title="10"> <span class="dt">"summary"</span><span class="fu">:</span> <span class="st">"Nothing works!"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-11" title="11"> <span class="dt">"content"</span><span class="fu">:</span> <span class="st">"<p>Please fix. <i>Everything</i> is broken!</p>"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-12" title="12"> <span class="dt">"mediaType"</span><span class="fu">:</span> <span class="st">"text/html"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-13" title="13"> <span class="dt">"source"</span><span class="fu">:</span> <span class="fu">{</span></a> + <a class="sourceLine" id="cb6-14" title="14"> <span class="dt">"content"</span><span class="fu">:</span> <span class="st">"Please fix. *Everything* is broken!"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-15" title="15"> <span class="dt">"mediaType"</span><span class="fu">:</span> <span class="st">"text/markdown; variant=CommonMark"</span></a> + <a class="sourceLine" id="cb6-16" title="16"> <span class="fu">},</span></a> + <a class="sourceLine" id="cb6-17" title="17"> <span class="dt">"assignedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb6-18" title="18"> <span class="dt">"isResolved"</span><span class="fu">:</span> <span class="kw">false</span></a> + <a class="sourceLine" id="cb6-19" title="19"><span class="fu">}</span></a></code></pre></div> <h1 id="properties"><span class="header-section-number">4</span> Properties</h1> <h2 id="assignedto"><span class="header-section-number">4.1</span> assignedTo</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#assignedTo</code></p> @@ -197,7 +197,7 @@ <p><strong>Example:</strong></p> <h2 id="isresolved"><span class="header-section-number">4.2</span> isResolved</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#isResolved</code></p> - <p><strong>Notes:</strong> Specifies whether the ticket is closed, i.e. the work on it is done and it doesn't need to attract attention anymore.</p> + <p><strong>Notes:</strong> Specifies whether the ticket is closed, i.e. the work on it is done and it doesn’t need to attract attention anymore.</p> <p><strong>Domain:</strong> <code>Ticket</code></p> <p><strong>Range:</strong> <code>xsd:boolean</code></p> <p><strong>Functional:</strong> Yes</p> @@ -205,7 +205,7 @@ <p><strong>Example:</strong></p> <h2 id="dependson"><span class="header-section-number">4.3</span> dependsOn</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#dependsOn</code></p> - <p><strong>Notes:</strong> Identifies one or more tickets on which this ticket depends, i.e. it can't be resolved without those tickets being resolved too.</p> + <p><strong>Notes:</strong> Identifies one or more tickets on which this ticket depends, i.e. it can’t be resolved without those tickets being resolved too.</p> <p><strong>Domain:</strong> <code>Ticket</code></p> <p><strong>Range:</strong> <code>Ticket</code></p> <p><strong>Functional:</strong> No</p> @@ -213,7 +213,7 @@ <p><strong>Example:</strong></p> <h2 id="dependedby"><span class="header-section-number">4.4</span> dependedBy</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#dependedBy</code></p> - <p><strong>Notes:</strong> Identifies one or more tickets which depends on this ticket, i.e. they can't be resolved without this tickets being resolved too.</p> + <p><strong>Notes:</strong> Identifies one or more tickets which depends on this ticket, i.e. they can’t be resolved without this tickets being resolved too.</p> <p><strong>Domain:</strong> <code>Ticket</code></p> <p><strong>Range:</strong> <code>Ticket</code></p> <p><strong>Functional:</strong> No</p> @@ -221,7 +221,7 @@ <p><strong>Example:</strong></p> <h2 id="dependencies"><span class="header-section-number">4.5</span> dependencies</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#dependencies</code></p> - <p><strong>Notes:</strong> Identifies a <code>Collection</code> of <code>TicketDependency</code> which specify tickets that this ticket depends on, i.e. this ticket is the <code>subject</code> of the <code>dependsOn</code> relationship.</p> + <p><strong>Notes:</strong> Identifies a <code>Collection</code> of <code>TicketDependency</code> which specify tickets that this ticket depends on, i.e. this ticket is the <code>subject</code> of the <code>dependsOn</code> relationship.</p> <p><strong>Domain:</strong> <code>Ticket</code></p> <p><strong>Range:</strong> <code>Collection</code> (of items of type <code>TicketDependency</code>)</p> <p><strong>Functional:</strong> Yes</p> @@ -229,7 +229,7 @@ <p><strong>Example:</strong></p> <h2 id="dependants"><span class="header-section-number">4.6</span> dependants</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#dependants</code></p> - <p><strong>Notes:</strong> Identifies a <code>Collection</code> of <code>TicketDependency</code> which specify tickets that depends on this ticket, i.e. this ticket is the <code>object</code> of the <code>dependsOn</code> relationship. Often called "reverse dependencies".</p> + <p><strong>Notes:</strong> Identifies a <code>Collection</code> of <code>TicketDependency</code> which specify tickets that depends on this ticket, i.e. this ticket is the <code>object</code> of the <code>dependsOn</code> relationship. Often called “reverse dependencies”.</p> <p><strong>Domain:</strong> <code>Ticket</code></p> <p><strong>Range:</strong> <code>Collection</code> (of items of type <code>TicketDependency</code>)</p> <p><strong>Functional:</strong> Yes</p> @@ -237,10 +237,27 @@ <p><strong>Example:</strong></p> </main> <footer class="footer"> - site generated by - <a class="footer__link" href="https://pandoc.org">pandoc</a>, - theme by - <a class="footer__link" href="https://keybase.io/iko">ikomi</a> + <p xmlns:dct="http://purl.org/dc/terms/"> + <a rel="license" + href="http://creativecommons.org/publicdomain/zero/1.0/"> + <img src="https://licensebuttons.net/p/zero/1.0/88x31.png" + style="border-style: none;" + alt="CC0" /> + </a> + <br /> + <a rel="dct:publisher" href="https://peers.community"> + <span property="dct:title">The ForgeFed team</span> + </a> + has dedicated all copyright and related and neighboring + rights to + <span property="dct:title">ForgeFed</span> to the public domain + worldwide. + </p> + <p>❤ Copying is an act of love. Please copy, reuse and share!</p> + <p> + Site generated by + <a class="footer__link" href="https://pandoc.org">pandoc</a>. + </p> </footer> </body> </html> diff --git a/html/forgefed.html b/html/forgefed.html index 00ee1cf..4ef2971 100644 --- a/html/forgefed.html +++ b/html/forgefed.html @@ -28,9 +28,9 @@ </header> <main class="main"> <h1 class="main-title"> - ForgeFed - draft - 2019-07-21 master - <a href="https://notabug.org/peers/forgefed/commit/f7d66c9ca691e3edaacd115e03bcdf287f720576"> - f7d66c9 + ForgeFed - draft - 2019-07-23 master + <a href="https://notabug.org/peers/forgefed/commit/b512bd569f1a8b01526ac25a92e5b328a7cb2651"> + b512bd5 </a> [dirty] </h1> @@ -60,19 +60,19 @@ <li>deesix</li> <li>fr33domlover</li> <li>zPlus</li> - <li>... add other editors</li> + <li>… add other editors</li> </ul> <p><strong>Repository:</strong></p> <ul> <li><a href="https://notabug.org/peers/forgefed">NotABug</a></li> </ul> <p><strong>Copyright:</strong></p> - <p>2019 ...</p> + <p>2019 …</p> <h1 id="abstract"><span class="header-section-number">1</span> Abstract</h1> <p>This document describes the ForgeFed protocol. ForgeFed is an extension of the <a href="https://www.w3.org/TR/activitypub/">ActivityPub</a> protocol for delivering notifications and content for federation of version control systems. The purpose of this specification is to describe a protocol that can be integrated into source code management for enabling collaboration across different platforms.</p> <h1 id="status-of-this-document"><span class="header-section-number">2</span> Status of This Document</h1> <h1 id="overview"><span class="header-section-number">3</span> Overview</h1> - <p>ForgeFed is an extension of <a href="https://www.w3.org/TR/activitypub/">ActivityPub</a> and follows the same "actors" model, with a client-to-server protocol and a server-to-server protocol.</p> + <p>ForgeFed is an extension of <a href="https://www.w3.org/TR/activitypub/">ActivityPub</a> and follows the same “actors” model, with a client-to-server protocol and a server-to-server protocol.</p> <h1 id="conformance"><span class="header-section-number">4</span> Conformance</h1> <p>The key words MAY, MUST, MUST NOT, SHOULD, and SHOULD NOT are to be interpreted as described in [RFC2119].</p> <h1 id="objects"><span class="header-section-number">5</span> Objects</h1> @@ -81,21 +81,38 @@ <p>A ForgeFed implementation MUST provide an Actor of type <code>Repository</code> for every repository that should support federation.</p> <p>A ForgeFed implementation SHOULD provide an Actor of type <code>Person</code> for every user of the platform.</p> <h1 id="client-to-server-interactions"><span class="header-section-number">7</span> Client to Server Interactions</h1> - <p>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.</p> + <p>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.</p> <h2 id="follow-activity"><span class="header-section-number">7.1</span> Follow Activity</h2> - <p>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.</p> + <p>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.</p> <h2 id="push-activity"><span class="header-section-number">7.2</span> Push Activity</h2> - <p>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.</p> + <p>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.</p> <h1 id="server-to-server-interactions"><span class="header-section-number">8</span> Server to Server Interactions</h1> <h2 id="follow-activity-1"><span class="header-section-number">8.1</span> Follow Activity</h2> - <p>The server receiving a Follow activity in a Repository's inbox SHOULD add the sender actor to the Repository's followers collection.</p> + <p>The server receiving a Follow activity in a Repository’s inbox SHOULD add the sender actor to the Repository’s followers collection.</p> <h1 id="acknowledgements"><span class="header-section-number">9</span> Acknowledgements</h1> </main> <footer class="footer"> - site generated by - <a class="footer__link" href="https://pandoc.org">pandoc</a>, - theme by - <a class="footer__link" href="https://keybase.io/iko">ikomi</a> + <p xmlns:dct="http://purl.org/dc/terms/"> + <a rel="license" + href="http://creativecommons.org/publicdomain/zero/1.0/"> + <img src="https://licensebuttons.net/p/zero/1.0/88x31.png" + style="border-style: none;" + alt="CC0" /> + </a> + <br /> + <a rel="dct:publisher" href="https://peers.community"> + <span property="dct:title">The ForgeFed team</span> + </a> + has dedicated all copyright and related and neighboring + rights to + <span property="dct:title">ForgeFed</span> to the public domain + worldwide. + </p> + <p>❤ Copying is an act of love. Please copy, reuse and share!</p> + <p> + Site generated by + <a class="footer__link" href="https://pandoc.org">pandoc</a>. + </p> </footer> </body> </html> diff --git a/html/index.html b/html/index.html index aeee2f4..5d5312b 100644 --- a/html/index.html +++ b/html/index.html @@ -33,10 +33,27 @@ </main> <footer class="footer"> - site generated by - <a class="footer__link" href="https://pandoc.org">pandoc</a>, - theme by - <a class="footer__link" href="https://keybase.io/iko">ikomi</a> + <p xmlns:dct="http://purl.org/dc/terms/"> + <a rel="license" + href="http://creativecommons.org/publicdomain/zero/1.0/"> + <img src="https://licensebuttons.net/p/zero/1.0/88x31.png" + style="border-style: none;" + alt="CC0" /> + </a> + <br /> + <a rel="dct:publisher" href="https://peers.community"> + <span property="dct:title">The ForgeFed team</span> + </a> + has dedicated all copyright and related and neighboring + rights to + <span property="dct:title">ForgeFed</span> to the public domain + worldwide. + </p> + <p>❤ Copying is an act of love. Please copy, reuse and share!</p> + <p> + Site generated by + <a class="footer__link" href="https://pandoc.org">pandoc</a>. + </p> </footer> </body> </html> diff --git a/html/template.html b/html/template.html index c25d851..a9c5a65 100644 --- a/html/template.html +++ b/html/template.html @@ -51,10 +51,27 @@ $body$ </main> <footer class="footer"> - site generated by - <a class="footer__link" href="https://pandoc.org">pandoc</a>, - theme by - <a class="footer__link" href="https://keybase.io/iko">ikomi</a> + <p xmlns:dct="http://purl.org/dc/terms/"> + <a rel="license" + href="http://creativecommons.org/publicdomain/zero/1.0/"> + <img src="https://licensebuttons.net/p/zero/1.0/88x31.png" + style="border-style: none;" + alt="CC0" /> + </a> + <br /> + <a rel="dct:publisher" href="https://peers.community"> + <span property="dct:title">The ForgeFed team</span> + </a> + has dedicated all copyright and related and neighboring + rights to + <span property="dct:title">ForgeFed</span> to the public domain + worldwide. + </p> + <p>❤ Copying is an act of love. Please copy, reuse and share!</p> + <p> + Site generated by + <a class="footer__link" href="https://pandoc.org">pandoc</a>. + </p> </footer> </body> </html> diff --git a/html/theme.css b/html/theme.css index fc0b650..8c1cdd2 100644 --- a/html/theme.css +++ b/html/theme.css @@ -17,6 +17,11 @@ body { padding: 1rem 10%; } +.footer { + text-align: center; + font-size: 80%; +} + blockquote { background-color: #f8f8f8; border-left: 5px solid #e9e9e9; |