From 8565bbb75c0cef40213e0d9df1fc683c75311f50 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Wed, 6 Jul 2022 22:14:28 +0200 Subject: [PATCH] refactor: kubo in ./docs --- docs/EARLY_TESTERS.md | 6 ++-- docs/PATCH_RELEASE_TEMPLATE.md | 6 ++-- docs/README.md | 8 ++--- docs/RELEASE_ISSUE_TEMPLATE.md | 12 ++++---- docs/config.md | 56 +++++++++++++++++----------------- docs/datastores.md | 4 +-- docs/debug-guide.md | 21 +++++++------ docs/environment-variables.md | 22 ++++++------- docs/experimental-features.md | 14 ++++----- docs/fuse.md | 2 +- docs/gateway.md | 12 +++++--- docs/implement-api-bindings.md | 22 ++++++------- docs/plugins.md | 52 +++++++++++++++---------------- docs/releases.md | 51 ++++++++++++++++--------------- docs/transports.md | 4 +-- docs/windows.md | 52 +++++++++++++++---------------- 16 files changed, 176 insertions(+), 168 deletions(-) diff --git a/docs/EARLY_TESTERS.md b/docs/EARLY_TESTERS.md index c68d00453f4..c3e9108772f 100644 --- a/docs/EARLY_TESTERS.md +++ b/docs/EARLY_TESTERS.md @@ -2,7 +2,7 @@ ## What is it? -The early testers programme allows groups using go-ipfs in production to self-volunteer to help test `go-ipfs` release candidates to ensure that no regressions that might affect production systems make it into the final release. While we invite the _entire_ community to help test releases, members of the early testers program are expected to participate directly and actively in every release. +The early testers programme allows groups using Kubo in production to self-volunteer to help test `kubo` release candidates to ensure that no regressions that might affect production systems make it into the final release. While we invite the _entire_ community to help test releases, members of the early testers program are expected to participate directly and actively in every release. ## What are the expectations? @@ -14,11 +14,11 @@ Members of the early tester program are expected to work closely with us to: We will ask early testers to participate at two points in the process: -* When go-ipfs enters the second release stage (public beta), early testers will be asked to test go-ipfs on non-production infrastructure. This may involve things like: +* When Kubo enters the second release stage (public beta), early testers will be asked to test Kubo on non-production infrastructure. This may involve things like: - Running integration tests against the release candidate. - Running simulations/benchmarks on the release candidate. - Manually testing the release candidate to check for regressions. -* When go-ipfs enters the third release stage (soft release), early testers will be asked to partially deploy the release candidate to production infrastructure. Release candidates at this stage are expected to be identical to the final release. However, this stage allows the go-ipfs team to fix any last-minute regressions without cutting an entirely new release. +* When Kubo enters the third release stage (soft release), early testers will be asked to partially deploy the release candidate to production infrastructure. Release candidates at this stage are expected to be identical to the final release. However, this stage allows the Kubo team to fix any last-minute regressions without cutting an entirely new release. ## Who has signed up? diff --git a/docs/PATCH_RELEASE_TEMPLATE.md b/docs/PATCH_RELEASE_TEMPLATE.md index 1cce02a4f27..127543d1429 100644 --- a/docs/PATCH_RELEASE_TEMPLATE.md +++ b/docs/PATCH_RELEASE_TEMPLATE.md @@ -1,6 +1,6 @@ # Patch Release Checklist -This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming that `vX.Y.Z` is the latest released version of go-ipfs. +This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming that `vX.Y.Z` is the latest released version of Kubo. - [ ] Get temporary permissions to force-push to `release-*` branches - [ ] Fork a new branch (`release-vX.Y.Z`) from `release` and cherry-pick the relevant commits from master (or custom fixes) onto this branch @@ -15,7 +15,7 @@ This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming 2. Pin the resulting release. 3. Make a PR against ipfs/distributions with the updated versions, including the new hash in the PR comment. 4. Ask the infra team to update the DNSLink record for dist.ipfs.io to point to the new distribution. -- [ ] cut a release on [github](https://github.com/ipfs/go-ipfs/releases) and upload the result of the ipfs/distributions build in the previous step. +- [ ] cut a release on [github](https://github.com/ipfs/kubo/releases) and upload the result of the ipfs/distributions build in the previous step. - Announce the Release: - [ ] On IRC/Matrix (both #ipfs and #ipfs-dev) - [ ] On discuss.ipfs.io @@ -24,7 +24,7 @@ This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming - [ ] to [npm-go-ipfs](https://github.com/ipfs/npm-go-ipfs) - [ ] to [chocolatey](https://chocolatey.org/packages/ipfs) - [ ] to [snap](https://snapcraft.io/ipfs) - - [ ] to [github](https://github.com/ipfs/go-ipfs/releases) + - [ ] to [github](https://github.com/ipfs/kubo/releases) - [ ] to [arch](https://www.archlinux.org/packages/community/x86_64/go-ipfs/) (flag it out of date) - [ ] Cut a new ipfs-desktop release - [ ] Merge the `release` branch back into `master`, ignoring the changes to `version.go` (keep the `-dev` version from master). diff --git a/docs/README.md b/docs/README.md index 13ba9219f27..7d867d3099b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,9 +6,9 @@ If you’re experiencing an issue with IPFS, **please follow [our issue guide](g Otherwise, check out the following guides to using and developing IPFS: -## Developing `go-ipfs` +## Developing `kubo` -- First, please read the Contributing Guidelines [for IPFS projects](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and then the Contributing Guidelines for [go-ipfs specifically](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md) +- First, please read the Contributing Guidelines [for IPFS projects](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and then the Contributing Guidelines for [Go code specifically](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md) - Building on… - [Windows](windows.md) - [Performance Debugging Guidelines](debug-guide.md) @@ -17,7 +17,7 @@ Otherwise, check out the following guides to using and developing IPFS: ## Guides - [How to Implement an API Client](implement-api-bindings.md) -- [Connecting with Websockets](transports.md) — if you want `js-ipfs` nodes in web browsers to connect to your `go-ipfs` node, you will need to turn on websocket support in your `go-ipfs` node. +- [Connecting with Websockets](transports.md) — if you want `js-ipfs` nodes in web browsers to connect to your `kubo` node, you will need to turn on websocket support in your `kubo` node. ## Advanced User Guides @@ -28,7 +28,7 @@ Otherwise, check out the following guides to using and developing IPFS: - [Installing command completion](command-completion.md) - [Mounting IPFS with FUSE](fuse.md) - [Installing plugins](plugins.md) -- [Setting up an IPFS Gateway](https://github.com/ipfs/go-ipfs/blob/master/docs/gateway.md) +- [Setting up an IPFS Gateway](https://github.com/ipfs/kubo/blob/master/docs/gateway.md) ## Other diff --git a/docs/RELEASE_ISSUE_TEMPLATE.md b/docs/RELEASE_ISSUE_TEMPLATE.md index 3f276f26305..bfa3bbca0e6 100644 --- a/docs/RELEASE_ISSUE_TEMPLATE.md +++ b/docs/RELEASE_ISSUE_TEMPLATE.md @@ -1,8 +1,8 @@ > Release Issue Template -# go-ipfs X.Y.Z Release +# Kubo X.Y.Z Release -We're happy to announce go-ipfs X.Y.Z, bla bla... +We're happy to announce Kubo X.Y.Z, bla bla... As usual, this release includes important fixes, some of which may be critical for security. Unless the fix addresses a bug being exploited in the wild, the fix will _not_ be called out in the release notes. Please make sure to update ASAP. See our [release process](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md#security-fix-policy) for details. @@ -29,7 +29,7 @@ For each RC published in each stage: 2. Pin the resulting release. 3. Make a PR against ipfs/distributions with the updated versions, including the new hash in the PR comment. 4. Ask the infra team to update the DNSLink record for dist.ipfs.io to point to the new distribution. -- cut a pre-release on [github](https://github.com/ipfs/go-ipfs/releases) and upload the result of the ipfs/distributions build in the previous step. +- cut a pre-release on [github](https://github.com/ipfs/kubo/releases) and upload the result of the ipfs/distributions build in the previous step. - Announce the RC: - [ ] On Matrix (both #ipfs and #ipfs-dev) - [ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md). Do this by copy/pasting their GitHub usernames and checkboxes as a comment so they get a GitHub notification. ([example](https://github.com/ipfs/go-ipfs/issues/8176#issuecomment-909356394)) @@ -40,7 +40,7 @@ Checklist: - [ ] Upgrade to the latest patch release of Go that CircleCI has published - [ ] See the list here: https://hub.docker.com/r/cimg/go/tags - [ ] [ipfs/distributions](https://github.com/ipfs/distributions): bump [this version](https://github.com/ipfs/distributions/blob/master/.tool-versions#L2) - - [ ] [ipfs/go-ipfs](https://github.com/ipfs/go-ipfs): [example PR](https://github.com/ipfs/go-ipfs/pull/8599) + - [ ] [ipfs/kubo](https://github.com/ipfs/kubo): [example PR](https://github.com/ipfs/kubo/pull/8599) - [ ] Fork a new branch (`release-vX.Y.Z`) from `master` and make any further release related changes to this branch. If any "non-trivial" changes (see the footnotes of [docs/releases.md](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md) for a definition) get added to the release, uncheck all the checkboxes and return to this stage. - [ ] Follow the RC release process to cut the first RC. - [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`. @@ -85,7 +85,7 @@ Checklist: - [ ] Manually run [the release workflow](https://github.com/ipfs/choco-go-ipfs/actions/workflows/main.yml) - [ ] to [snap](https://snapcraft.io/ipfs) - [ ] to [github](https://github.com/ipfs/go-ipfs/releases) - - [ ] use the artifacts built in CI for dist.ipfs.io: `wget "https://ipfs.io/api/v0/get?arg=/ipns/dist.ipfs.io/go-ipfs/$(curl -s https://dist.ipfs.io/go-ipfs/versions | tail -n 1)"` + - [ ] use the artifacts built in CI for dist.ipfs.io: `wget "https://ipfs.io/api/v0/get?arg=/ipns/dist.ipfs.io/kubo/$(curl -s https://dist.ipfs.io/kubo/versions | tail -n 1)"` - [ ] to [arch](https://www.archlinux.org/packages/community/x86_64/go-ipfs/) (flag it out of date) - [ ] Cut a new ipfs-desktop release - [ ] Submit [this form](https://airtable.com/shrNH8YWole1xc70I) to publish a blog post, linking to the GitHub release notes @@ -124,7 +124,7 @@ The best place to ask your questions about IPFS, how it works and what you can d Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started: -- Check the issues with the `help wanted` label in the [go-ipfs repo](https://github.com/ipfs/go-ipfs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) +- Check the issues with the `help wanted` label in the [ipfs/kubo repo](https://github.com/ipfs/kubo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) - Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt/#weekly-ipfs-all-hands - Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built - Join the discussion at [discuss.ipfs.io](https://discuss.ipfs.io/) and help users finding their answers. diff --git a/docs/config.md b/docs/config.md index deb91cb490b..29e76af239b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,13 +1,13 @@ -# The go-ipfs config file +# The Kubo config file -The go-ipfs config file is a JSON document located at `$IPFS_PATH/config`. It +The Kubo (go-ipfs) config file is a JSON document located at `$IPFS_PATH/config`. It is read once at node instantiation, either for an offline command, or when starting the daemon. Commands that execute on a running daemon do not read the config file at runtime. # Table of Contents -- [The go-ipfs config file](#the-go-ipfs-config-file) +- [The Kubo config file](#the-kubo-config-file) - [Table of Contents](#table-of-contents) - [Profiles](#profiles) - [Types](#types) @@ -245,7 +245,7 @@ This document refers to the standard JSON types (e.g., `null`, `string`, Flags allow enabling and disabling features. However, unlike simple booleans, they can also be `null` (or omitted) to indicate that the default value should -be chosen. This makes it easier for go-ipfs to change the defaults in the +be chosen. This makes it easier for Kubo to change the defaults in the future unless the user _explicitly_ sets the flag to either `true` (enabled) or `false` (disabled). Flags have three possible states: @@ -281,7 +281,7 @@ does (e.g, `"1d2h4m40.01s"`). Optional integers allow specifying some numerical value which has an implicit default when missing from the config file: -- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault(value)`) +- `null`/missing will apply the default value defined in Kubo sources (`.WithDefault(value)`) - an integer between `-2^63` and `2^63-1` (i.e. `-9223372036854775808` to `9223372036854775807`) ### `optionalBytes` @@ -289,7 +289,7 @@ an implicit default when missing from the config file: Optional Bytes allow specifying some number of bytes which has an implicit default when missing from the config file: -- `null`/missing (apply the default value defined in go-ipfs sources) +- `null`/missing (apply the default value defined in Kubo sources) - a string value indicating the number of bytes, including human readable representations: - [SI sizes](https://en.wikipedia.org/wiki/Metric_prefix#List_of_SI_prefixes) (metric units, powers of 1000), e.g. `1B`, `2kB`, `3MB`, `4GB`, `5TB`, …) - [IEC sizes](https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes) (binary units, powers of 1024), e.g. `1B`, `2KiB`, `3MiB`, `4GiB`, `5TiB`, …) @@ -299,7 +299,7 @@ an implicit default when missing from the config file: Optional strings allow specifying some string value which has an implicit default when missing from the config file: -- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault("value")`) +- `null`/missing will apply the default value defined in Kubo sources (`.WithDefault("value")`) - a string ### `optionalDuration` @@ -307,7 +307,7 @@ an implicit default when missing from the config file: Optional durations allow specifying some duration value which has an implicit default when missing from the config file: -- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault("1h2m3s")`) +- `null`/missing will apply the default value defined in Kubo sources (`.WithDefault("1h2m3s")`) - a string with a valid [go duration](#duration) (e.g, `"1d2h4m40.01s"`). ## `Addresses` @@ -431,7 +431,7 @@ Type: `string` (one of `"enabled"` or `"disabled"`) ### `AutoNAT.Throttle` When set, this option configure's the AutoNAT services throttling behavior. By -default, go-ipfs will rate-limit the number of NAT checks performed for other +default, Kubo will rate-limit the number of NAT checks performed for other nodes to 30 per minute, and 3 per peer. ### `AutoNAT.Throttle.GlobalLimit` @@ -671,7 +671,7 @@ Type: `bool` ### `Gateway.PathPrefixes` -**DEPRECATED:** see [go-ipfs#7702](https://github.com/ipfs/go-ipfs/issues/7702) +**DEPRECATED:** see [kubo#7702](https://github.com/ipfs/kubo/issues/7702)