Skip to content

Commit 66488d2

Browse files
cwaringcwaring
authored
Merge pull request #35 from ipfs/feat-legacy-callouts
On beta, adds callout for feedback/beta signup/equivalent legacy pages
2 parents 8713936 + f5df7ef commit 66488d2

37 files changed

+153
-7
lines changed

‎docs/.vuepress/theme/components/LegacyCallout.vue

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<template>
2+
<div class="tip custom-block legacy-callout">
3+
<p>
4+
This site is in beta.
5+
<a
6+
href="https://github.com/ipfs/docs/issues/new?assignees=&labels=OKR+3%3A+Content+Improvement%2C+docs-ipfs&template=documentation-issue.md&title=%5BDOCS+ISSUE%5D+Beta+Site+Feedback"
7+
target="_blank"
8+
>Submit feedback</a
9+
>
10+
<span v-if="$site.themeConfig.betaTestFormUrl">
11+
or
12+
<a :href="$site.themeConfig.betaTestFormUrl" target="_blank"
13+
>become a tester</a
14+
>
15+
</span>
16+
to help us improve it!
17+
<span v-if="legacyUrl" class="content-status-status">
18+
<br />
19+
<a target="_blank" :href="legacyUrl">View this page on legacy site</a>
20+
</span>
21+
</p>
22+
</div>
23+
</template>
24+
25+
<script>
26+
export default {
27+
computed: {
28+
legacyUrl: function() {
29+
return this.$frontmatter && this.$frontmatter.legacyUrl
30+
}
31+
}
32+
}
33+
</script>
34+
35+
<style lang="stylus" scoped>
36+
.legacy-callout {
37+
background-color: #f6f9fa;
38+
color: #737681;
39+
border-color: #5db5be;
40+
}
41+
42+
@media (min-width: $MQNarrow) {
43+
}
44+
</style>

‎docs/.vuepress/theme/global-components/LegacyCallout.vue

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<template>
2+
<main class="content-status">
3+
<div>
4+
<div class="tip custom-block legacy-callout">
5+
<p>
6+
<b>
7+
This site is in beta. Help us improve it!
8+
</b>
9+
</p>
10+
<p>
11+
<a
12+
href="https://github.com/ipfs/docs/issues/new?assignees=&labels=OKR+3%3A+Content+Improvement%2C+docs-ipfs&template=content-request.md&title=%5BCONTENT+REQUEST%5D+%28add+your+title+here%21%29"
13+
target="_blank"
14+
>
15+
Suggest new content
16+
</a>
17+
<br />
18+
<a href="https://ipfs.canny.io/docs-features" target="_blank">
19+
Request features
20+
</a>
21+
<br />
22+
<a
23+
href="https://github.com/ipfs/docs/issues/new?assignees=&labels=OKR+3%3A+Content+Improvement%2C+docs-ipfs&template=documentation-issue.md&title=%5BDOCS+ISSUE%5D+%28add+your+title+here%21%29"
24+
target="_blank"
25+
>
26+
Give general feedback
27+
</a>
28+
<br />
29+
<span v-if="$site.themeConfig.betaTestFormUrl">
30+
<a :href="$site.themeConfig.betaTestFormUrl" target="_blank">
31+
Become a tester
32+
</a>
33+
</span>
34+
<br />
35+
<span v-if="legacyUrl" class="content-status-status">
36+
<br />
37+
<a target="_blank" :href="legacyUrl"
38+
>View this page on legacy site</a
39+
>
40+
</span>
41+
</p>
42+
</div>
43+
</div>
44+
</main>
45+
</template>
46+
47+
<script>
48+
export default {
49+
computed: {
50+
legacyUrl: function() {
51+
return this.$frontmatter && this.$frontmatter.legacyUrl
52+
}
53+
}
54+
}
55+
</script>
56+
57+
<style lang="stylus" scoped>
58+
.legacy-callout {
59+
background-color:#f6f9fa;
60+
color: #737681;
61+
border-color: #5db5be;
62+
}
63+
@media (min-width: $MQNarrow) {
64+
}
65+
</style>

‎docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: IPFS Documentation
3+
legacyUrl: https://docs.ipfs.io/
34
---
45

56
# IPFS Documentation

‎docs/community/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Community
3+
legacyUrl: https://docs.ipfs.io/community/
34
---
45

56
# Community

‎docs/community/irc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: IRC
3+
legacyUrl: https://docs.ipfs.io/community/irc/
34
---
45

56
# Internet Relay Chat (IRC)

‎docs/community/social-media.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Social media
33
sidebarDepth: 0
4+
legacyUrl: https://docs.ipfs.io/community/
45
---
56

67
# Social media

‎docs/concepts/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Concepts
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/
34
---
45

56
# IPFS concepts

‎docs/concepts/content-addressing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Content addressing
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/cid/
34
---
45

56
# Content addressing and CIDs

‎docs/concepts/dht.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Distributed Hash Tables (DHTs)
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/dht/
34
---
45

56
# Distributed Hash Tables (DHTs)

‎docs/concepts/dnslink.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: DNSLink
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/dnslink/
34
---
45

56
# DNSLink

‎docs/concepts/faq.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: FAQ
3+
legacyUrl: https://docs.ipfs.io/introduction/faq/
34
---
45

56
# Frequently asked questions

‎docs/concepts/file-systems.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: File systems
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/mfs/
34
---
45

56
# File systems and IPFS

‎docs/concepts/hashing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Hashing
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/hashes/
34
---
45

56
# Hashing

‎docs/concepts/how-ipfs-works.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: How IPFS works
3+
legacyUrl: https://docs.ipfs.io/introduction/how-ipfs-works/
34
---
45

56
# How IPFS works

‎docs/concepts/ipns.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: IPNS
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/ipns/
34
---
45

56
# InterPlanetary Name System (IPNS)

‎docs/concepts/merkle-dag.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Merkle DAGs
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/merkle-dag/
34
---
45

56
# Merkle Distributed Acyclic Graphs (DAGs)

‎docs/concepts/persistence.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Persistence
3+
legacyUrl: https://docs.ipfs.io/guides/concepts/pinning/
34
---
45

56
# Persistence, permanence and pinning

‎docs/concepts/what-is-ipfs.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
22
title: What is IPFS?
3+
legacyUrl: https://docs.ipfs.io/introduction/overview/
34
---
45

6+
# What is IPFS?
7+
58
Let's just start with a one-line definition of IPFS:
69

710
**IPFS is a distributed system for storing and accessing files, websites, applications, and data.**

‎docs/how-to/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: How-tos
3+
legacyUrl: https://docs.ipfs.io/guides/examples/
34
---
45

56
# IPFS how-tos and tutorials

‎docs/how-to/address-ipfs-on-web.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Address IPFS on the Web
3+
legacyUrl: https://docs.ipfs.io/guides/guides/addressing/
34
---
45

56
# Address IPFS on the Web

‎docs/how-to/command-line-quick-start.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Command-line quick start
3+
legacyUrl: https://docs.ipfs.io/introduction/usage/
34
---
45

56
# Command-line quick start

‎docs/how-to/configure-node.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Configure a node
3+
legacyUrl: https://docs.ipfs.io/guides/examples/config/
34
---
45

56
# Configure a node

‎docs/how-to/host-git-style-repo.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Host a Git-style repo
3+
legacyUrl: https://docs.ipfs.io/guides/examples/git/
34
---
45

56
# Host a Git-style repo

‎docs/how-to/host-single-page-site.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Host a single-page site
3+
legacyUrl: https://docs.ipfs.io/guides/examples/websites/
34
---
45

56
# Host a single-page website

‎docs/how-to/modify-bootstrap-list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Modify the bootstrap list
3+
legacyUrl: https://docs.ipfs.io/guides/examples/bootstrap/
34
---
45

56
# Modify the bootstrap peers list

‎docs/how-to/observe-peers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Observe peers
3+
legacyUrl: https://docs.ipfs.io/guides/examples/network/
34
---
45

56
# Observe peers

‎docs/how-to/pin-files.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Pin files
3+
legacyUrl: https://docs.ipfs.io/guides/examples/pinning/
34
---
45

56
# Pin files using IPFS

‎docs/how-to/store-play-videos.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Store & play videos
3+
legacyUrl: https://docs.ipfs.io/guides/examples/videos/
34
---
45

56
# Store and play videos

‎docs/how-to/take-snapshot.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Take a snapshot
3+
legacyUrl: https://docs.ipfs.io/guides/examples/snapshots/
34
---
45

56
# Take a snapshot

‎docs/how-to/work-with-blocks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Work with blocks
3+
legacyUrl: https://docs.ipfs.io/guides/examples/blocks/
34
---
45

56
# Work with blocks

‎docs/install/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Install IPFS
33
sidebarDepth: 0
4+
legacyUrl: https://docs.ipfs.io/introduction/usage/
45
---
56

67
# Install IPFS

‎docs/project/contribute.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Contribute to IPFS
3+
legacyUrl: https://docs.ipfs.io/community/contribute/how-to-help/
34
---
45

56
# Contribute to IPFS

‎docs/reference/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: API & CLI
3+
legacyUrl: https://docs.ipfs.io/reference/api/
34
---
45

56
# API & CLI reference

‎docs/reference/cli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: CLI commands
3+
legacyUrl: https://docs.ipfs.io/reference/api/cli/
34
---
45

56
# Command-line interface (CLI) reference

‎docs/reference/go/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: go-ipfs API
3+
legacyUrl: https://docs.ipfs.io/reference/go/overview/
34
---
45

56
# API resources for go-ipfs

‎docs/reference/http/api.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: HTTP API
3+
legacyUrl: https://docs.ipfs.io/reference/api/http/
34
---
45

56
# HTTP API reference
@@ -88,12 +89,14 @@ flag is the `&encoding=json` query parameter below:
8889
```
8990

9091
## HTTP status codes
92+
9193
Status codes used at the RPC layer are simple:
92-
* `500` - RPC endpoint returned an error
93-
* `404` - RPC endpoint doesn't exist
94-
* `400` - Malformed RPC, argument type error, etc
95-
* `403` - RPC call forbidden
96-
In other words, `500` means that the function _does_ exist, it just failed internally for some reason. To know that reason, you have to look at the "application layer" error (commands lib error).
94+
95+
- `500` - RPC endpoint returned an error
96+
- `404` - RPC endpoint doesn't exist
97+
- `400` - Malformed RPC, argument type error, etc
98+
- `403` - RPC call forbidden
99+
In other words, `500` means that the function _does_ exist, it just failed internally for some reason. To know that reason, you have to look at the "application layer" error (commands lib error).
97100

98101
## HTTP commands
99102

@@ -3626,5 +3629,3 @@ On success, the call to this endpoint will return with 200 and the following bod
36263629
### cURL Example
36273630

36283631
`curl "http://localhost:5001/api/v0/version/deps"`
3629-
3630-

‎docs/reference/js/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: js-ipfs API
3+
legacyUrl: https://docs.ipfs.io/reference/js/
34
---
45

56
# API resources for js-ipfs

0 commit comments

Comments
 (0)