Skip to content

Commit

Permalink
docs: editorial fixes to ipips
Browse files Browse the repository at this point in the history
  • Loading branch information
hacdias committed May 9, 2023
1 parent 4cc2aea commit 9388d0f
Show file tree
Hide file tree
Showing 16 changed files with 197 additions and 69 deletions.
4 changes: 3 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@

# global IPIP
IPIP/ @ipfs/specs-stewards
src/ipips/ @ipfs/specs-stewards

# Selected Spec Stewards can be defined below to be automatically requested for
# review when someone opens a pull request that modifies area of their
# interest.

http-gateways/ @lidel
http-gateways/ @lidel
src/http-gateways/ @lidel
23 changes: 14 additions & 9 deletions ipip-template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# IPIP-0: InterPlanetary Improvement Proposal Template

<!-- IPIP number should match its pull request number. After you open a PR,
please update title and include anqabbreviated title in the filename too:
`0000-draft-title-abbrev.md`. -->

- Start Date: YYYY-MM-DD
- Related Issues:
- (add links here)
---
# IPIP number should match its pull request number. After you open a PR,
# please update title and update the filename to `ipip0000`.
date: YYYY-MM-DD
ipip: proposal
editors:
- name: Your Name
relatedIssues:
- link to issue
order: 0000
tags: ['ipips']
---

# IPIP-0000: InterPlanetary Improvement Proposal Template

## Summary

Expand Down
6 changes: 6 additions & 0 deletions src/_includes/ipips-list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<dl>
{% assign sortedPosts = collections.ipips | sortByOrder | reverse %}
{%- for post in sortedPosts -%}
<dt><a href="{{ post.url }}">{{ post.data.title }}</a></dt>
{%- endfor -%}
</dl>
21 changes: 21 additions & 0 deletions src/css/specs.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,27 @@ body {
line-height: 1.5;
}

.watermark {
display: none;
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
z-index: -999;
pointer-events: none;
}

.ipip-proposal .watermark {
display: block;
background: url('/img/watermark-proposal.svg');
}

.ipip-ratified .watermark {
display: block;
background: url('/img/watermark-ratified.svg');
}

#ipseity-back-to-root {
margin-bottom: 2rem;
background: var(--standard-gradient);
Expand Down
8 changes: 8 additions & 0 deletions src/img/watermark-proposal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions src/img/watermark-ratified.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,15 @@ <h3><a href="/ipns/">InterPlanetary Naming System</a></h3>
</p>
{% include 'list.html', posts: collections.ipns %}
</section>
<section>
<h3><a href="/ipips/">InterPlanetary Improvement Proposals</a></h3>
<p>
InterPlanetary Improvement Proposals (IPIP) are an <a href="/meta/ipip-process">orderly mechanism</a> to consider
changes to the IPFS specification. They are not changes to the specification itself,
but their approval leads to a change in the specification.
</p>
{% include 'ipips-list.html' %}
</section>
</div>
</section>
</main>
Expand Down
15 changes: 15 additions & 0 deletions src/ipips/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: InterPlanetary Improvement Proposals
description: |
An InterPlanetary Improvement Proposals (IPIP) provides an orderly mechanism for
considering proposed changes to IPFS specifications. An IPIP proposal is not to be the spec itself;
the approval of an IPIP leads to an update to a specification.
---

{% include 'header.html' %}

<main>
{% include 'ipips-list.html' %}
</main>

{% include 'footer.html' %}
27 changes: 17 additions & 10 deletions src/ipips/ipip-0001.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# IPIP 0001: Lightweight Improvement Process for IPFS Specifications

- Start Date: 2022-06-10
- Related Issues:
- [ipfs/specs/issues/286](https://github.com/ipfs/specs/issues/286)

## Summary
---
title: "IPIP-0001: Lightweight Improvement Process for IPFS Specifications"
date: 2022-06-10
ipip: ratified
editors:
- name: Marcin Rataj
github: lidel
- name: wilkyr31d
github: wilkyr31d
relatedIssues:
- https://github.com/ipfs/specs/issues/286
order: 1
tags: ['ipips']
---

This _InterPlanetary Improvement Proposal_ (IPIP) introduces a lightweight
"request for comments/change" process for the IPFS specifications
Expand Down Expand Up @@ -45,7 +52,7 @@ To illustrate:

### IPIP Lifecycle

Up-to-date process and IPIP lifecycle will be published in [`ipfs/specs/IPIP_PROCESS.md`](../IPIP_PROCESS.md).
Up-to-date process and IPIP lifecycle will be published in :cite[ipip-process].

<details>
<summary>Click to expand the initial (historical) flow</summary>
Expand All @@ -56,10 +63,10 @@ Changes to IPFS specifications can be proposed by opening a Git pull-request
(PR) against the `ipfs/specs` repository.

In addition to specification changes, such PR must include a short **IPIP
document** based on the template in [`ipfs/specs/IPIP/0000-template.md`](./0000-template.md).
document** based on the template in [`ipfs/specs/ipip-template.md`](https://github.com/ipfs/specs/blob/main/ipip-template.md).

When a new specification file is added to the repo, it should be based on
the template at [`ipfs/specs/template.md`](../template.md).
the template at [`ipfs/specs/template.md`](https://github.com/ipfs/specs/blob/main/template.md).

### Reviewing IPIPs

Expand Down
30 changes: 20 additions & 10 deletions src/ipips/ipip-0002.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# IPIP 0002: _redirects File Support on Web Gateways

- Start Date: 2022-06-15
- Related Issues:
- [ipfs/specs/issues/257](https://github.com/ipfs/specs/issues/257)
- [ipfs/kubo/pull/8890](https://github.com/ipfs/kubo/pull/8890)
- [ipfs-docs/pull/1275](https://github.com/ipfs/ipfs-docs/pull/1275)

## Summary
---
title: "IPIP-0002: _redirects File Support on Web Gateways"
date: 2022-06-15
ipip: ratified
editors:
- name: Justin Johnson
github: justincjohnson
- name: Marcin Rataj
github: lidel
- name: Henrique Dias
github: hacdias
url: https://hacdias.com/
relatedIssues:
- https://github.com/ipfs/specs/issues/257
- https://github.com/ipfs/kubo/pull/8890
- https://github.com/ipfs/ipfs-docs/pull/1275
order: 2
tags: ['ipips']
---

Provide support for URL redirects and rewrites for web sites hosted on Subdomain or DNSLink Gateways, thus enabling support for [single-page applications (SPAs)](https://en.wikipedia.org/wiki/Single-page_application), and avoiding [link rot](https://en.wikipedia.org/wiki/Link_rot) when moving to IPFS-backed hosting.

Expand Down Expand Up @@ -36,7 +46,7 @@ For performance reasons this proposal does not include forced redirect support (

If a `_redirects` file exists but is unable to be processed, perhaps not even parsing correctly, errors will be returned to the user viewing the site via the Gateway.

The detailed specification is added in [`http-gateways/REDIRECTS_FILE.md`](../http-gateways/REDIRECTS_FILE.md).
The detailed specification is added in :cite[web-redirects-file].

### Test fixtures

Expand Down
26 changes: 18 additions & 8 deletions src/ipips/ipip-0288.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
# IPIP-288: TAR Response Format on HTTP Gateways

- Start Date: 2022-06-10
- Related Issues:
- [ipfs/specs/pull/288](https://github.com/ipfs/specs/pull/288)
- [ipfs/go-ipfs/pull/9029](https://github.com/ipfs/go-ipfs/pull/9029)
- [ipfs/go-ipfs/pull/9034](https://github.com/ipfs/go-ipfs/pull/9034)
---
title: "IPIP-0288: TAR Response Format on HTTP Gateways"
date: 2022-06-10
ipip: ratified
editors:
- name: Henrique Dias
github: hacdias
url: https://hacdias.com/
- name: Marcin Rataj
github: lidel
relatedIssues:
- https://github.com/ipfs/specs/pull/288
- https://github.com/ipfs/go-ipfs/pull/9029
- https://github.com/ipfs/go-ipfs/pull/9034
order: 288
tags: ['ipips']
---

## Summary

Add TAR response format to the [HTTP Gateway](../http-gateways/).
Add TAR response format to the :cite[path-gateway].

## Motivation

Expand Down
32 changes: 22 additions & 10 deletions src/ipips/ipip-0328.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
# IPIP-328: JSON and CBOR Response Formats on HTTP Gateways

- Start Date: 2022-10-07
- Related Issues:
- [ipfs/in-web-browsers/issues/182]
- [ipfs/specs/pull/328]
- [ipfs/kubo/issues/8823]
- [ipfs/kubo/pull/9335]
- [ipfs/go-ipfs/issues/7552]
---
title: "IPIP-0328: JSON and CBOR Response Formats on HTTP Gateways"
date: 2022-10-07
ipip: ratified
editors:
- name: Henrique Dias
github: hacdias
url: https://hacdias.com/
- name: Marcin Rataj
github: lidel
- name: Gus Eggert
github: guseggert
relatedIssues:
- https://github.com/ipfs/in-web-browsers/issues/182
- https://github.com/ipfs/specs/pull/328
- https://github.com/ipfs/kubo/issues/8823
- https://github.com/ipfs/kubo/pull/9335
- https://github.com/ipfs/kubo/issues/7552
order: 328
tags: ['ipips']
---

## Summary

Add support for the [DAG-JSON], [DAG-CBOR], JSON and CBOR response formats in
the [HTTP Gateway](../http-gateways/).
the :cite[path-gateway].

## Motivation

Expand Down
17 changes: 13 additions & 4 deletions src/ipips/ipip-0337.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# IPIP-337: Delegated Content Routing HTTP API

- Start Date: 2022-10-18
- Related Issues:
---
title: "IPIP-0337: Delegated Content Routing HTTP API"
date: 2022-10-18
ipip: ratified
editors:
- name: Gus Eggert
github: guseggert
- name: Marcin Rataj
github: lidel
relatedIssues:
- https://github.com/ipfs/specs/pull/337
order: 337
tags: ['ipips']
---

## Summary

Expand Down
37 changes: 21 additions & 16 deletions src/meta/ipip-process.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# IPIP: Improvement Process for IPFS Specifications

- [Introduction](#introduction)
- [Process design](#process-design)
- [What is an IPIP?](#what-is-an-ipip)
- [What changes need the IPIP process?](#what-changes-need-the-ipip-process)
- [Improvement lifecycle](#improvement-lifecycle)
- [Opening an improvement proposal (IPIP)](#opening-an-improvement-proposal-ipip)
- [Reviewing IPIPs](#reviewing-ipips)
- [Things not covered by this document](#things-not-covered-by-this-document)
---
title: "IPIP: Improvement Process for IPFS Specifications"
description: >
The specification documenting the process through which a new IPIP should be proposed.
date: 2023-02-23
editors:
- name: Marcin Rataj
github: lidel
- name: Guillaume Michel
github: guillaumemichel
- name: Henrique Dias
github: hacdias
url: https://hacdias.com/
order: 1
---

## Introduction

Expand Down Expand Up @@ -35,10 +40,10 @@ a specification.**
To illustrate:

- In order to understand how (hypothetical) WebDAV Gateway works, one would
read contents of specs in `ipfs/specs/WEBDAV_GATEWAY.md`.
- IPIP in `ipfs/specs/IPIP/000N-webdav-gateway.md` would only include
read contents of specs in `ipfs/specs/src/webdav-gateway.md`.
- IPIP in `ipfs/specs/src/ipips/ipip-000N.md` would only include
**Motivation** and explainer why certain design decisions were made at a
certain point in time. Initial `IPIP/000N-webdav-gateway.md` would explain
certain point in time. Initial `ipip-000N.md` would explain
why we added WebDAV spec in the first place.

### What changes need the IPIP process?
Expand All @@ -47,7 +52,7 @@ To illustrate:
- **Does Not need IPIP**: Adding more details, test vectors, and editorials/cosmetic changes
- **Needs IPIP**: An addition to the protocol
- **Needs IPIP**:Things that could cause an interop issues require a PR with fix and IPIP in
`ipfs/specs/IPIP/000M-webdav-fix-for-foo.md` explaining why we make the
`ipfs/specs/src/ipips/ipip-000M.md` explaining why we make the
breaking spec change, compatibility/migration considerations etc.

## Improvement lifecycle
Expand All @@ -58,10 +63,10 @@ Changes to IPFS specifications can be proposed by opening a Git pull-request
(PR) against the `ipfs/specs` repository.

In addition to specification changes, such PR must include a short **IPIP
document** based on the template in [`ipfs/specs/IPIP/0000-template.md`](./IPIP/0000-template.md).
document** based on the template in [`ipfs/specs/ipip-template.md`](https://github.com/ipfs/specs/blob/main/ipip-template.md).

When a new specification file is added to the repo, it should be based on
the template at [`ipfs/specs/template.md`](./template.md).
the template at [`ipfs/specs/template.md`](https://github.com/ipfs/specs/blob/main/template.md).

When naming a new proposal, don't try to introduce an IPIP number; we will do that only for
IPIPs that are approved before accepting into `main` branch.
Expand Down
2 changes: 1 addition & 1 deletion src/meta/spec-for-specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ xref:
- dom
- test-methodology
tags: ['meta']
order: 1
order: 2
---

This document specifies the format and system used to create and maintain specifications for
Expand Down
1 change: 1 addition & 0 deletions template.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@
</nav>
<ipseity-header></ipseity-header>
${body}
<div class='watermark'></div>
</body>
</html>

0 comments on commit 9388d0f

Please sign in to comment.