Skip to content

On beta, adds callout for feedback/beta signup/equivalent legacy pages #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Dec 10, 2019
44 changes: 44 additions & 0 deletions docs/.vuepress/theme/components/LegacyCallout.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<template>
<div class="tip custom-block legacy-callout">
<p>
This site is in beta.
<a
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"
target="_blank"
>Submit feedback</a
>
<span v-if="$site.themeConfig.betaTestFormUrl">
or
<a :href="$site.themeConfig.betaTestFormUrl" target="_blank"
>become a tester</a
>
</span>
to help us improve it!
<span v-if="legacyUrl" class="content-status-status">
<br />
<a target="_blank" :href="legacyUrl">View this page on legacy site</a>
</span>
</p>
</div>
</template>

<script>
export default {
computed: {
legacyUrl: function() {
return this.$frontmatter && this.$frontmatter.legacyUrl
}
}
}
</script>

<style lang="stylus" scoped>
.legacy-callout {
background-color: #f6f9fa;
color: #737681;
border-color: #5db5be;
}

@media (min-width: $MQNarrow) {
}
</style>
65 changes: 65 additions & 0 deletions docs/.vuepress/theme/global-components/LegacyCallout.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<template>
<main class="content-status">
<div>
<div class="tip custom-block legacy-callout">
<p>
<b>
This site is in beta. Help us improve it!
</b>
</p>
<p>
<a
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"
target="_blank"
>
Suggest new content
</a>
<br />
<a href="https://ipfs.canny.io/docs-features" target="_blank">
Request features
</a>
<br />
<a
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"
target="_blank"
>
Give general feedback
</a>
<br />
<span v-if="$site.themeConfig.betaTestFormUrl">
<a :href="$site.themeConfig.betaTestFormUrl" target="_blank">
Become a tester
</a>
</span>
<br />
<span v-if="legacyUrl" class="content-status-status">
<br />
<a target="_blank" :href="legacyUrl"
>View this page on legacy site</a
>
</span>
</p>
</div>
</div>
</main>
</template>

<script>
export default {
computed: {
legacyUrl: function() {
return this.$frontmatter && this.$frontmatter.legacyUrl
}
}
}
</script>

<style lang="stylus" scoped>
.legacy-callout {
background-color:#f6f9fa;
color: #737681;
border-color: #5db5be;
}
@media (min-width: $MQNarrow) {
}
</style>
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: IPFS Documentation
legacyUrl: https://docs.ipfs.io/
---

# IPFS Documentation
Expand Down
1 change: 1 addition & 0 deletions docs/community/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Community
legacyUrl: https://docs.ipfs.io/community/
---

# Community
Expand Down
1 change: 1 addition & 0 deletions docs/community/irc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: IRC
legacyUrl: https://docs.ipfs.io/community/irc/
---

# Internet Relay Chat (IRC)
Expand Down
1 change: 1 addition & 0 deletions docs/community/social-media.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Social media
sidebarDepth: 0
legacyUrl: https://docs.ipfs.io/community/
---

# Social media
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Concepts
legacyUrl: https://docs.ipfs.io/guides/concepts/
---

# IPFS concepts
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/content-addressing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Content addressing
legacyUrl: https://docs.ipfs.io/guides/concepts/cid/
---

# Content addressing and CIDs
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/dht.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Distributed Hash Tables (DHTs)
legacyUrl: https://docs.ipfs.io/guides/concepts/dht/
---

# Distributed Hash Tables (DHTs)
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/dnslink.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: DNSLink
legacyUrl: https://docs.ipfs.io/guides/concepts/dnslink/
---

# DNSLink
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/faq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: FAQ
legacyUrl: https://docs.ipfs.io/introduction/faq/
---

# Frequently asked questions
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/file-systems.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: File systems
legacyUrl: https://docs.ipfs.io/guides/concepts/mfs/
---

# File systems and IPFS
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/hashing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Hashing
legacyUrl: https://docs.ipfs.io/guides/concepts/hashes/
---

# Hashing
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/how-ipfs-works.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: How IPFS works
legacyUrl: https://docs.ipfs.io/introduction/how-ipfs-works/
---

# How IPFS works
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/ipns.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: IPNS
legacyUrl: https://docs.ipfs.io/guides/concepts/ipns/
---

# InterPlanetary Name System (IPNS)
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/merkle-dag.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Merkle DAGs
legacyUrl: https://docs.ipfs.io/guides/concepts/merkle-dag/
---

# Merkle Distributed Acyclic Graphs (DAGs)
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/persistence.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Persistence
legacyUrl: https://docs.ipfs.io/guides/concepts/pinning/
---

# Persistence, permanence and pinning
Expand Down
3 changes: 3 additions & 0 deletions docs/concepts/what-is-ipfs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: What is IPFS?
legacyUrl: https://docs.ipfs.io/introduction/overview/
---

# What is IPFS?

Let's just start with a one-line definition of IPFS:

**IPFS is a distributed system for storing and accessing files, websites, applications, and data.**
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: How-tos
legacyUrl: https://docs.ipfs.io/guides/examples/
---

# IPFS how-tos and tutorials
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/address-ipfs-on-web.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Address IPFS on the Web
legacyUrl: https://docs.ipfs.io/guides/guides/addressing/
---

# Address IPFS on the Web
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/command-line-quick-start.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Command-line quick start
legacyUrl: https://docs.ipfs.io/introduction/usage/
---

# Command-line quick start
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/configure-node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Configure a node
legacyUrl: https://docs.ipfs.io/guides/examples/config/
---

# Configure a node
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/host-git-style-repo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Host a Git-style repo
legacyUrl: https://docs.ipfs.io/guides/examples/git/
---

# Host a Git-style repo
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/host-single-page-site.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Host a single-page site
legacyUrl: https://docs.ipfs.io/guides/examples/websites/
---

# Host a single-page website
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/modify-bootstrap-list.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Modify the bootstrap list
legacyUrl: https://docs.ipfs.io/guides/examples/bootstrap/
---

# Modify the bootstrap peers list
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/observe-peers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Observe peers
legacyUrl: https://docs.ipfs.io/guides/examples/network/
---

# Observe peers
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/pin-files.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Pin files
legacyUrl: https://docs.ipfs.io/guides/examples/pinning/
---

# Pin files using IPFS
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/store-play-videos.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Store & play videos
legacyUrl: https://docs.ipfs.io/guides/examples/videos/
---

# Store and play videos
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/take-snapshot.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Take a snapshot
legacyUrl: https://docs.ipfs.io/guides/examples/snapshots/
---

# Take a snapshot
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/work-with-blocks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Work with blocks
legacyUrl: https://docs.ipfs.io/guides/examples/blocks/
---

# Work with blocks
Expand Down
1 change: 1 addition & 0 deletions docs/install/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Install IPFS
sidebarDepth: 0
legacyUrl: https://docs.ipfs.io/introduction/usage/
---

# Install IPFS
Expand Down
1 change: 1 addition & 0 deletions docs/project/contribute.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Contribute to IPFS
legacyUrl: https://docs.ipfs.io/community/contribute/how-to-help/
---

# Contribute to IPFS
Expand Down
1 change: 1 addition & 0 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: API & CLI
legacyUrl: https://docs.ipfs.io/reference/api/
---

# API & CLI reference
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: CLI commands
legacyUrl: https://docs.ipfs.io/reference/api/cli/
---

# Command-line interface (CLI) reference
Expand Down
1 change: 1 addition & 0 deletions docs/reference/go/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: go-ipfs API
legacyUrl: https://docs.ipfs.io/reference/go/overview/
---

# API resources for go-ipfs
Expand Down
15 changes: 8 additions & 7 deletions docs/reference/http/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: HTTP API
legacyUrl: https://docs.ipfs.io/reference/api/http/
---

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

## HTTP status codes

Status codes used at the RPC layer are simple:
* `500` - RPC endpoint returned an error
* `404` - RPC endpoint doesn't exist
* `400` - Malformed RPC, argument type error, etc
* `403` - RPC call forbidden
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).

- `500` - RPC endpoint returned an error
- `404` - RPC endpoint doesn't exist
- `400` - Malformed RPC, argument type error, etc
- `403` - RPC call forbidden
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).

## HTTP commands

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

`curl "http://localhost:5001/api/v0/version/deps"`


1 change: 1 addition & 0 deletions docs/reference/js/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: js-ipfs API
legacyUrl: https://docs.ipfs.io/reference/js/
---

# API resources for js-ipfs
Expand Down