[Content Request] Document IPNI / Indexers

[honghaoq]

We are working on Network indexer that index IPFS and Filecoin contents. We should add indexing doc / pointer on the ipfs page here under peer-to-peer-sharing https://docs.ipfs.tech/concepts/#peer-to-peer-sharing.

We can leverage the indexer gitbook to build the content page: docs.cid.contact

[welcome]

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

• "Priority" labels will show how urgent this is for the team.
• "Status" labels will show if this is ready to be worked on, blocked, or in progress.
• "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.tech if you just need general support.

[honghaoq]

@TMoMoreau fyi

[jacobheun]

Perhaps this is a separate issue but documenting reframe would be super useful. There's various resources you can find but querying reframe on the site doesn't yield any results.

https://github.com/ipfs/kubo/releases/tag/v0.16.0 has configuration guidance.
https://blog.ipfs.tech/2022-09-02-introducing-reframe/ has useful information for understanding reframe as well as some curl commands to verify reframe servers.
https://github.com/ipfs-shipyard/someguy is also a useful tool for it, from @aschmahmann -

Generally I'd just use someguy ask --endpoint=https://cid.contact/reframe findprovs <cid> (or put a --pretty before the findprovs keyword) (https://github.com/ipfs-shipyard/someguy).

[lidel]

"IPNI" (InterPlanetary Network Indexer) should be added to glossary: https://docs.ipfs.tech/concepts/glossary/
Ref. https://github.com/ipni

[TMoMoreau]

I'll get a draft PR made for this. Going to make a list here as well, to verify and keep track of what needs to be done.

• Add pointer for the Filecoin network indexer to the list under the peer to peer file sharing subsection, found here: https://docs.ipfs.tech/concepts/#peer-to-peer-file-sharing
• Potentially create new doc for the Filecoin network indexer. I say potentially because I am wondering if the pointer leading to the already existing docs would be the better option.
• Add IPNI to the glossary using https://github.com/ipni as a reference. (Should we also add a link to the IPNI github repo?)

@jacobheun I think it would be best to make a separate issue for the reframe documentation topic.

@lidel @honghaoq

[honghaoq]

Thanks. FYI Torfinn Olsen is gonna be the new indexer PM on this going forward.