@cryptotaxi247 / kubo / commits / 5af3cc1c0

docs: updated links and refs to external resources (#10368)

Marcin Rataj committed Mar 16, 2024 at 00:59 UTC 5af3cc1c025f55aa7595563c3d1a8b5180b76189
10 files changed +55 -16
.github/ISSUE_TEMPLATE/bug-report.yml
+1 -1
@@ -18,7 +18,7 @@ body:
18 label: Checklist
19 description: Please verify that you've followed these steps
20 options:
21 - - label: This is a bug report, not a question. Ask questions on [discuss.ipfs.io](https://discuss.ipfs.io).
21 + - label: This is a bug report, not a question. Ask questions on [discuss.ipfs.tech](https://discuss.ipfs.tech/c/help/13).
22 required: true
23 - label: I have searched on the [issue tracker](https://github.com/ipfs/kubo/issues?q=is%3Aissue) for my bug.
24 required: true
.github/ISSUE_TEMPLATE/config.yml
+4 -4
@@ -1,7 +1,7 @@
1 blank_issues_enabled: false
2 contact_links:
3 - name: Getting Help on IPFS
4 - url: https://ipfs.io/help
4 + url: https://ipfs.tech/help
5 about: All information about how and where to get help on IPFS.
6 - name: Kubo configuration reference
7 url: https://github.com/ipfs/kubo/blob/master/docs/config.md#readme
@@ -9,9 +9,9 @@ contact_links:
9 - name: Kubo experimental features docs
10 url: https://github.com/ipfs/kubo/blob/master/docs/experimental-features.md#readme
11 about: Documentation on Private Networks, Filestore and other experimental features.
12 - - name: RPC API Reference
12 + - name: Kubo RPC API Reference
13 url: https://docs.ipfs.tech/reference/kubo/rpc/
14 about: Documentation of all Kubo RPC API endpoints.
15 - - name: IPFS Official Forum
16 - url: https://discuss.ipfs.io
15 + - name: IPFS Official Discussion Forum
16 + url: https://discuss.ipfs.tech
17 about: Please post general questions, support requests, and discussions here.
.github/ISSUE_TEMPLATE/enhancement.yml
+2 -2
@@ -6,11 +6,11 @@ body:
6 - type: markdown
7 attributes:
8 value: |
9 - Suggest an enhancement to Kubo (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io).
9 + Suggest an enhancement to Kubo (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.tech).
10
11 Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas.
12
13 - If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.io).
13 + If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.tech).
14
15 **Example:**
16
.github/ISSUE_TEMPLATE/feature.yml
+2 -2
@@ -6,11 +6,11 @@ body:
6 - type: markdown
7 attributes:
8 value: |
9 - Suggest a new feature in Kubo (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io).
9 + Suggest a new feature in Kubo (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.tech).
10
11 Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas.
12
13 - If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.io).
13 + If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.tech).
14
15 **Example:**
16
README.md
+21 -2
@@ -123,7 +123,24 @@ Official images are published at https://hub.docker.com/r/ipfs/kubo/:
123
124 [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/ipfs/kubo?color=blue&label=kubo%20docker%20image&logo=docker&sort=semver&style=flat-square&cacheSeconds=3600)](https://hub.docker.com/r/ipfs/kubo/)
125
126 -More info on how to run Kubo (go-ipfs) inside Docker can be found [here](https://docs.ipfs.tech/how-to/run-ipfs-inside-docker/).
126 +- 🟢 Releases
127 + - `latest` and `release` tags always point at [the latest stable release](https://github.com/ipfs/kubo/releases/latest)
128 + - `vN.N.N` points at a specific [release tag](https://github.com/ipfs/kubo/releases)
129 + - These are production grade images.
130 +- 🟠 We also provide experimental developer builds
131 + - `master-latest` always points at the `HEAD` of the `master` branch
132 + - `master-YYYY-DD-MM-GITSHA` points at a specific commit from the `master` branch
133 + - These tags are used by developers for internal testing, not intended for end users or production use.
134 +
135 +```console
136 +$ docker pull ipfs/kubo:latest
137 +$ docker run --rm -it --net=host ipfs/kubo:latest
138 +```
139 +
140 +To [customize your node](https://docs.ipfs.tech/install/run-ipfs-inside-docker/#customizing-your-node),
141 +pass necessary config via `-e` or by mounting scripts in the `/container-init.d`.
142 +
143 +Learn more at https://docs.ipfs.tech/install/run-ipfs-inside-docker/
144
145 ### Official prebuilt binaries
146
@@ -428,7 +445,9 @@ We ❤️ all [our contributors](docs/AUTHORS); this project wouldn’t be what
445
446 This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
447
431 -Please reach out to us in one [chat](https://docs.ipfs.tech/community/chat/) rooms.
448 +Members of IPFS community provide Kubo support on [discussion forum category here](https://discuss.ipfs.tech/c/help/help-kubo/23).
449 +
450 +Need help with IPFS itself? Learn where to get help and support at https://ipfs.tech/help.
451
452 ## License
453
cmd/ipfs/dist/README.md
+2 -1
@@ -1,6 +1,7 @@
1 # ipfs command line tool
2
3 -This is the [ipfs](http://ipfs.io) command line tool. It contains a full ipfs node.
3 +This is a [command line tool for interacting with Kubo](https://docs.ipfs.tech/install/command-line/),
4 +an [IPFS](https://ipfs.tech) implementation. It contains a full IPFS node.
5
6 ## Install
7
docs/RELEASE_CHECKLIST.md
+1 -1
@@ -90,7 +90,7 @@ This section covers tasks to be done during each release.
90 - [ ] create and merge the PR which updates `dists/kubo/versions` and `dists/go-ipfs/versions` (![](https://img.shields.io/badge/only-FINAL-green?style=flat-square) and `dists/kubo/current_version` and `dists/go-ipfs/current_version`)
91 - [example](https://github.com/ipfs/distributions/pull/760)
92 - [ ] wait for the [CI](https://github.com/ipfs/distributions/actions/workflows/main.yml) workflow run initiated by the merge to master to finish
93 - - [ ] verify the release is available on [dist.ipfs.io](https://dist.ipfs.io/#kubo)
93 + - [ ] verify the release is available on [dist.ipfs.tech](https://dist.ipfs.tech/#kubo)
94 </details>
95 - [ ] Publish the release to [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions) <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-npm` (⚠️ you might need to run the command a couple of times because GHA might not be able to see the new distribution straight away due to caching) or ...</summary>
96 - [ ] run the [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow
docs/gateway.md
+16 -2
@@ -13,7 +13,9 @@ Kubo's Gateway implementation follows [ipfs/specs: Specification for HTTP Gatewa
13 By default, Kubo nodes run
14 a [path gateway](https://docs.ipfs.tech/how-to/address-ipfs-on-web/#path-gateway) at `http://127.0.0.1:8080/`
15 and a [subdomain gateway](https://docs.ipfs.tech/how-to/address-ipfs-on-web/#subdomain-gateway) at `http://localhost:8080/`.
16 -Both support [trustless responses](https://docs.ipfs.tech/reference/http/gateway/#trustless-verifiable-retrieval) as opt-in via `Accept` header.
16 +
17 +The path one also implements [trustless gateway spec](https://specs.ipfs.tech/http-gateways/trustless-gateway/)
18 +and supports [trustless responses](https://docs.ipfs.tech/reference/http/gateway/#trustless-verifiable-retrieval) as opt-in via `Accept` header.
19
20 Additional listening addresses and gateway behaviors can be set in the [config](#configuration) file.
21
@@ -65,7 +67,7 @@ Gateway](https://dnslink.dev/#example-ipfs-gateway) for instructions.
67 When downloading files, browsers will usually guess a file's filename by looking
68 at the last component of the path. Unfortunately, when linking *directly* to a
69 file (with no containing directory), the final component is just a CID
68 -(`Qm...`). This isn't exactly user-friendly.
70 +(`bafy..` or `Qm...`). This isn't exactly user-friendly.
71
72 To work around this issue, you can add a `filename=some_filename` parameter to
73 your query string to explicitly specify the filename. For example:
@@ -89,6 +91,11 @@ or by sending `Accept: application/vnd.ipld.{format}` HTTP header with one of su
91
92 ## Content-Types
93
94 +Majority of resources can be retrieved trustlessly by requesting specific content type via `Accept` header or `?format=raw|car|ipns-record` URL query parameter.
95 +
96 +See [trustless gateway specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/)
97 +and [verifiable retrieval documentation](https://docs.ipfs.tech/reference/http/gateway/#trustless-verifiable-retrieval) for more details.
98 +
99 ### `application/vnd.ipld.raw`
100
101 Returns a byte array for a single `raw` block.
@@ -106,3 +113,10 @@ Right now only 'full DAG' implicit selector is implemented.
113 Support for user-provided IPLD selectors is tracked in https://github.com/ipfs/kubo/issues/8769.
114
115 This is a rough equivalent of `ipfs dag export`.
116 +
117 +### `application/vnd.ipfs.ipns-record`
118 +
119 +Only works on `/ipns/{ipns-name}` content paths that use cryptographically signed [IPNS Records](https://specs.ipfs.tech/ipns/ipns-record/).
120 +
121 +Returns [IPNS Record in Protobuf Serialization Format](https://specs.ipfs.tech/ipns/ipns-record/#record-serialization-format)
122 +which can be verified on end client, without trusting gateway.
docs/http-rpc-clients.md
+5
@@ -6,3 +6,8 @@ Kubo provides official HTTP RPC (`/api/v0`) clients for selected languages:
6 |:--------:|:-------------------:|--------------------------------------------|
7 | JS | kubo-rpc-client | https://github.com/ipfs/js-kubo-rpc-client |
8 | Go | `rpc` | [`../client/rpc`](../client/rpc) |
9 +
10 +There are community-maintained libraries for other languages,
11 +but the Kubo team does provide support for them, YMMV:
12 +
13 +- https://docs.ipfs.tech/reference/kubo-rpc-cli/
docs/windows.md
+1 -1
@@ -153,6 +153,6 @@ If you get authentication problems with Git, you might want to take a look at ht
153 `git config --global credential.helper wincred`
154
155 - **Anything else**
156 -Please search [https://discuss.ipfs.io](https://discuss.ipfs.io/search?q=windows%20category%3A13) for any additional issues you may encounter. If you can't find any existing resolution, feel free to post a question asking for help.
156 +Please search [https://discuss.ipfs.tech](https://discuss.ipfs.tech/search?q=windows%20category%3A13) for any additional issues you may encounter. If you can't find any existing resolution, feel free to post a question asking for help.
157
158 If you encounter a bug with `kubo` itself (not related to building) please use the [issue tracker](https://github.com/ipfs/kubo/issues) to report it.