Skip to content

Commit f8194ae

Browse files
hacdiashacdias
committed
docs: editorial fixes to ipips
1 parent 494f542 commit f8194ae

16 files changed

+197
-69
lines changed

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55

66
# global IPIP
77
IPIP/ @ipfs/specs-stewards
8+
src/ipips/ @ipfs/specs-stewards
89

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

13-
http-gateways/ @lidel
14+
http-gateways/ @lidel
15+
src/http-gateways/ @lidel

‎ipip-template.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
# IPIP-0: InterPlanetary Improvement Proposal Template
2-
3-
<!-- IPIP number should match its pull request number. After you open a PR,
4-
please update title and include anqabbreviated title in the filename too:
5-
`0000-draft-title-abbrev.md`. -->
6-
7-
- Start Date: YYYY-MM-DD
8-
- Related Issues:
9-
- (add links here)
1+
---
2+
# IPIP number should match its pull request number. After you open a PR,
3+
# please update title and update the filename to `ipip0000`.
4+
date: YYYY-MM-DD
5+
ipip: proposal
6+
editors:
7+
- name: Your Name
8+
relatedIssues:
9+
- link to issue
10+
order: 0000
11+
tags: ['ipips']
12+
---
13+
14+
# IPIP-0000: InterPlanetary Improvement Proposal Template
1015

1116
## Summary
1217

‎src/_includes/ipips-list.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<dl>
2+
{% assign sortedPosts = collections.ipips | sortByOrder | reverse %}
3+
{%- for post in sortedPosts -%}
4+
<dt><a href="{{ post.url }}">{{ post.data.title }}</a></dt>
5+
{%- endfor -%}
6+
</dl>

‎src/css/specs.css‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,27 @@ body {
99
line-height: 1.5;
1010
}
1111

12+
.watermark {
13+
display: none;
14+
position: fixed;
15+
top: 0;
16+
left: 0;
17+
width: 100%;
18+
height: 100%;
19+
z-index: -999;
20+
pointer-events: none;
21+
}
22+
23+
.ipip-proposal .watermark {
24+
display: block;
25+
background: url('/img/watermark-proposal.svg');
26+
}
27+
28+
.ipip-ratified .watermark {
29+
display: block;
30+
background: url('/img/watermark-ratified.svg');
31+
}
32+
1233
#ipseity-back-to-root {
1334
margin-bottom: 2rem;
1435
background: var(--standard-gradient);

‎src/img/watermark-proposal.svg‎

Lines changed: 8 additions & 0 deletions
Loading

‎src/img/watermark-ratified.svg‎

Lines changed: 8 additions & 0 deletions
Loading

‎src/index.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ <h3><a href="/ipns/">InterPlanetary Naming System</a></h3>
9494
</p>
9595
{% include 'list.html', posts: collections.ipns %}
9696
</section>
97+
<section>
98+
<h3><a href="/ipips/">InterPlanetary Improvement Proposals</a></h3>
99+
<p>
100+
InterPlanetary Improvement Proposals (IPIP) are an <a href="/meta/ipip-process">orderly mechanism</a> to consider
101+
changes to the IPFS specification. They are not changes to the specification itself,
102+
but their approval leads to a change in the specification.
103+
</p>
104+
{% include 'ipips-list.html' %}
105+
</section>
97106
</div>
98107
</section>
99108
</main>

‎src/ipips/index.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: InterPlanetary Improvement Proposals
3+
description: |
4+
An InterPlanetary Improvement Proposals (IPIP) provides an orderly mechanism for
5+
considering proposed changes to IPFS specifications. An IPIP proposal is not to be the spec itself;
6+
the approval of an IPIP leads to an update to a specification.
7+
---
8+
9+
{% include 'header.html' %}
10+
11+
<main>
12+
{% include 'ipips-list.html' %}
13+
</main>
14+
15+
{% include 'footer.html' %}

‎src/ipips/ipip-0001.md‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1-
# IPIP 0001: Lightweight Improvement Process for IPFS Specifications
2-
3-
- Start Date: 2022-06-10
4-
- Related Issues:
5-
- [ipfs/specs/issues/286](https://github.com/ipfs/specs/issues/286)
6-
7-
## Summary
1+
---
2+
title: "IPIP-0001: Lightweight Improvement Process for IPFS Specifications"
3+
date: 2022-06-10
4+
ipip: ratified
5+
editors:
6+
- name: Marcin Rataj
7+
github: lidel
8+
- name: wilkyr31d
9+
github: wilkyr31d
10+
relatedIssues:
11+
- https://github.com/ipfs/specs/issues/286
12+
order: 1
13+
tags: ['ipips']
14+
---
815

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

4653
### IPIP Lifecycle
4754

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

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

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

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

6471
### Reviewing IPIPs
6572

‎src/ipips/ipip-0002.md‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
1-
# IPIP 0002: _redirects File Support on Web Gateways
2-
3-
- Start Date: 2022-06-15
4-
- Related Issues:
5-
- [ipfs/specs/issues/257](https://github.com/ipfs/specs/issues/257)
6-
- [ipfs/kubo/pull/8890](https://github.com/ipfs/kubo/pull/8890)
7-
- [ipfs-docs/pull/1275](https://github.com/ipfs/ipfs-docs/pull/1275)
8-
9-
## Summary
1+
---
2+
title: "IPIP-0002: _redirects File Support on Web Gateways"
3+
date: 2022-06-15
4+
ipip: ratified
5+
editors:
6+
- name: Justin Johnson
7+
github: justincjohnson
8+
- name: Marcin Rataj
9+
github: lidel
10+
- name: Henrique Dias
11+
github: hacdias
12+
url: https://hacdias.com/
13+
relatedIssues:
14+
- https://github.com/ipfs/specs/issues/257
15+
- https://github.com/ipfs/kubo/pull/8890
16+
- https://github.com/ipfs/ipfs-docs/pull/1275
17+
order: 2
18+
tags: ['ipips']
19+
---
1020

1121
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.
1222

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

3747
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.
3848

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

4151
### Test fixtures
4252

0 commit comments

Comments
 (0)