Skip to content

Commit cce026c

Browse files
hacdiashacdias
committed
docs: editorial fixes to ipips
1 parent b006b85 commit cce026c

17 files changed

+192
-68
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

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
SPEC_GENERATOR_VER=v1.1.4
1+
SPEC_GENERATOR_VER=v1.1.7
22

33
all: website
44

‎ipip-template.md‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
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+
---
11+
12+
# IPIP-0000: InterPlanetary Improvement Proposal Template
1013

1114
## Summary
1215

‎src/_includes/specs/ipips.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<dl>
2+
<dt><a href="/ipips/ipip-0337/">IPIP-0337: Delegated Content Routing HTTP API</a></dt>
3+
<dt><a href="/ipips/ipip-0328/">IPIP-0328: JSON and CBOR Response Formats on HTTP Gateways</a></dt>
4+
<dt><a href="/ipips/ipip-0288/">IPIP-0288: TAR Response Format on HTTP Gateways</a></dt>
5+
<dt><a href="/ipips/ipip-0002/">IPIP-0002: _redirects File Support on Web Gateways</a></dt>
6+
<dt><a href="/ipips/ipip-0001/">IPIP-0001: Lightweight Improvement Process for IPFS Specifications</a></dt>
7+
</dl>

‎src/_includes/specs/meta.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
<dd>
44
The code of conduct that all community participants are held to.
55
</dd>
6+
<dt><a href="/meta/ipip-process/">IPIP Process</a></dt>
7+
<dd>
8+
The specification documenting the process throuh which a new IPIP should be proposed.
9+
</dd>
610
<dt><a href="/meta/spec-for-specs/">Spec for Specs</a></dt>
711
<dd>
812
Specifies the format and system used to create and maintain specifications for

‎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
@@ -95,6 +95,15 @@ <h3><a href="/ipns/">InterPlanetary Naming System</a></h3>
9595
</p>
9696
{% include 'specs/ipns.html' %}
9797
</section>
98+
<section>
99+
<h3><a href="/ipips/">InterPlanetary Improvement Proposals</a></h3>
100+
<p>
101+
InterPlanetary Improvement Proposals (IPIP) are an <a href="/meta/ipip-process">orderly mechanism</a> to consider
102+
changes to the IPFS specification. They are not changes to the specification itself,
103+
but their approval leads to a change in the specification.
104+
</p>
105+
{% include 'specs/ipips.html' %}
106+
</section>
98107
</div>
99108
</section>
100109
</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 'specs/ipips.html' %}
13+
</main>
14+
15+
{% include 'footer.html' %}

0 commit comments

Comments
 (0)