otterscan / otterscan-book

This is the source code for the official Otterscan documentation
https://docs.otterscan.io/
Other
4 stars 3 forks source link

Provide better docs for Sourcify #21

Open wmitsuda opened 2 weeks ago

wmitsuda commented 2 weeks ago

I think we should now provide a proper documentation for using Otterscan + Sourcify using the repo v2 format (while we don't have/find a good way to run it from parquet files)

maybe some copy/pastable example of downloading the 30GB (200GB unpacked) + one liner CLI to serve directory + otterscan config to wire that local server?

and delete the other methods that are not feasible anymore, hence supporting only central repo v1 server and filesystem download repo v2.

sealer3 commented 2 weeks ago

Do you mean we should also remove IPFS support since by default it provides few benefits? We should have an issue on the main repo too.

The other method that's not feasible anymore, which I will remove, is the outdated section for an Otterscan-provided Local snapshot.

wmitsuda commented 1 week ago

Last time I tried, the IPNS was not working, that + let's say IPNS was working, one would want to pin it locally for faster access, but it would take ages to download everything via IPFS.

I'm inclined to remove this option and only support "central sourcify server" and "download filesystem V2" (+good docs for downloading the whole package and setting up the config on otterscan)

WDYT?

wmitsuda commented 1 week ago

ah yes, and "local snapshot" does not make sense anymore if sourcify themselves now produce daily tar.gz of everything.

sealer3 commented 1 week ago

I'm inclined to remove the IPNS support, too. Should we support multiple Sourcify sources (switcher could still be used if more than one source is configured) or remove the switcher altogether? Using a local repo but also having the ability to switch to the main Sourcify repository would be the primary use case for keeping a switcher.

wmitsuda commented 1 week ago

what if: if there is only the "centralized server" preconfigured option, we add an additional menu item linking to the docs explaining how to configure a local datasource?

that way we incentivize users to "discover" this alternative option, only need to find a "not ugly" menu item description