Overhaul IPFS Troubleshooting guides with new content and structure #2046
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
remove pl-diagnose which isn't maintained and operated
🚀 Build Preview on IPFS ready
|
2color
changed the title
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR restructures and enriches the IPFS troubleshooting documentation by introducing high-level guides, adding new diagnostic tool references, and updating navigation.
- Adds a new “Helia Identify” section to the diagnostic tools reference
- Overhauls the main troubleshooting guide with broader retrieval/providing sections and integrates IPFS Check
- Splits out a dedicated “Troubleshooting Kubo” page and updates sidebars and redirects accordingly
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/diagnostic-tools.md | Added “Helia Identify” browser‐based identify tool |
| docs/how-to/troubleshooting.md | Expanded troubleshooting guide, integrated IPFS Check |
| docs/how-to/troubleshooting-kubo.md | New dedicated Kubo troubleshooting instructions |
| docs/.vuepress/redirects | Redirect updated from gateway-troubleshooting |
| docs/.vuepress/config.js | Sidebar groups updated for troubleshooting guides |
| docs/concepts/public-utilities.md | Added “IPFS Check” tool description |
| docs/concepts/lifecycle.md | Updated providing step to mention reproviding |
Comments suppressed due to low confidence (1)
docs/how-to/troubleshooting.md:5
- [nitpick] There's an unfinished TODO block left in HTML comments—either remove it or flesh out the items so it's actionable.
<!-- ## TODO
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
lidel
reviewed
Jun 11, 2025
|
|
||
| ### Analyzing vars and memory statistics | ||
| - **Change the reprovider strategy from `all` to either `pinned` or `roots`.** In both cases, only provider records for explicitly pinned content are advertised. Differences and tradeoffs are noted below: |
There was a problem hiding this comment.
nit: good place to push people towards newly added pinned+mfs, and not just pinned
Suggested change
| - **Change the reprovider strategy from `all` to either `pinned` or `roots`.** In both cases, only provider records for explicitly pinned content are advertised. Differences and tradeoffs are noted below: | |
| - **Change the [Reprovider Strategy](https://github.com/ipfs/kubo/blob/master/docs/config.md#reproviderstrategy) from `all` to either `pinned+mfs` or `roots`.** In both cases, only provider records for explicitly pinned content are advertised. Differences and tradeoffs are noted below: |
|
|
||
| ### Analyzing vars and memory statistics | ||
| - **Change the reprovider strategy from `all` to either `pinned` or `roots`.** In both cases, only provider records for explicitly pinned content are advertised. Differences and tradeoffs are noted below: | ||
| - The `pinned` strategy will advertise both the root CIDs and child block CIDs (the entire DAG) of explicitly pinned content. |
There was a problem hiding this comment.
Suggested change
| - The `pinned` strategy will advertise both the root CIDs and child block CIDs (the entire DAG) of explicitly pinned content. | |
| - The `pinned+mfs` strategy will advertise both the root CIDs and child block CIDs (the entire DAG) of explicitly pinned content and the locally available part of MFS. |
|
|
||
| ### Analyzing the CPU Profile | ||
| 2. Note the value for `LastReprovideDuration`. If it is close to 48 hours, select one of the following options, keeping in mind that each has tradeoffs: |
There was a problem hiding this comment.
💭 depending on the strategy, the field right now will show how long a batch took, not the whole thing. I think its fine to keep the text here as-is – it will match reality once we have landed reprovide refactors in 0.36 and 0.37, however for now lets add this:
Suggested change
| 2. Note the value for `LastReprovideDuration`. If it is close to 48 hours, select one of the following options, keeping in mind that each has tradeoffs: | |
| 2. Note the value for `LastReprovideDuration`. If it is close to 48 hours, or if you notice a "reprovide taking too long" warning in your `ipfs daemon` output log, select one of the following options, keeping in mind that each has tradeoffs: |
|
|
||
|  | ||
|
|
||
| ## Troubleshooting with Kubo |
There was a problem hiding this comment.
Since we have "### Troubleshooting providing with Kubo", maybe rename this to "### Troubleshooting retrieval with Kubo", and put it after "### Troubleshooting retrieval with IPFS Check" + add ipfs block get as one extra step if providers are found?
Co-authored-by: Marcin Rataj <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Related to ipshipyard/roadmaps#13