Add geospatial publishing guide #2243
Open
+226
−9
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
Contributor
🚀 Build Preview on IPFS ready
|
Collaborator
|
This is great as a specific how-to. Is there another, complementary place we can write about all the ways geospatial users can benefit from IPFS? From live meeting:
|
mishmosh
approved these changes
Feb 4, 2026
|
|
||
| Before starting, ensure you have: | ||
|
|
||
| - A Zarr data set for |
| Before starting, ensure you have: | ||
|
|
||
| - A Zarr data set for | ||
| - [Kubo](/install/command-line/) or [IPFS Desktop](/install/ipfs-desktop/) installed on a machine with a public IP |
Collaborator
There was a problem hiding this comment.
machine with a public IP
can we link to a resource to help people check if they have a public IP, or configure one if not?
|
|
||
| 1. **Merkleizes** the folder: converts files and directories into content-addressed blocks with UnixFS | ||
| 2. **Pins** the data locally: prevents garbage collection from removing it | ||
| 3. **Queues providing**: announces to the IPFS network that your node has this data |
Collaborator
There was a problem hiding this comment.
"Queues providing" introduces multiple new terms at once. Would any of these alternates work?
- Broadcasts availability
- Starts providing
- Starts advertising
- Advertises the content
|
|
||
| ## Step 5: Content Discovery | ||
|
|
||
| Users need a way to discover your datasets. Choose an approach based on your needs: |
Collaborator
There was a problem hiding this comment.
Suggested change
| Users need a way to discover your datasets. Choose an approach based on your needs: | |
| Now that your data is available on the public network, the next step is making it discoverable to others. Choose a sharing approach based on your needs: |
|
|
||
| ### Option B: Use IPNS for Updatable References | ||
|
|
||
| IPNS provides a stable identifier that you can update when datasets change: |
Collaborator
There was a problem hiding this comment.
Suggested change
| IPNS provides a stable identifier that you can update when datasets change: | |
| If you want to share a stable identifier but be able to update the underlying dataset, create an [IPNS](https://docs.ipfs.tech/concepts/ipns/) identifier and share that instead. This is useful for datasets that get updated regularly —users can bookmark your IPNS name and always retrieve the latest version. |
(not sure if that's the correct way to link internally)
| ipfs name publish /ipfs/<new-dataset-cid> | ||
| ``` | ||
|
|
||
| Users can subscribe to your IPNS name to always get the latest version. |
Collaborator
There was a problem hiding this comment.
Is this an explicit, persistent "subscribe" function? Or do we recommend using it like an IPFS CID (in which case maybe we should describe this without the word "subscribe")
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Add a new geospatial publishing guide
Preview: https://bafybeiaj6f6pnzpoq4ktj5ubgw4de7fk7fzfixvcj7fipignkdwmo2ubk4.ipfs.dweb.link/how-to/publish-geospatial-data/