Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add an umbrella page for CS Filecoin services #5182

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

LesnyRumcajs
Copy link
Member

@LesnyRumcajs LesnyRumcajs commented Jan 24, 2025

Summary of changes

Changes introduced in this pull request:

  • added an umbrella page for Chainsafe's Filecoin services (potentially to be a redirect for filecoin.chainsafe.io

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

@LesnyRumcajs LesnyRumcajs force-pushed the umbrella-page-fil-services branch from 56b2a82 to 3734195 Compare January 24, 2025 13:10
@LesnyRumcajs LesnyRumcajs marked this pull request as ready for review January 24, 2025 13:45
@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner January 24, 2025 13:45
@LesnyRumcajs LesnyRumcajs requested review from lemmih and removed request for a team January 24, 2025 13:45
Copy link
Member

@ansermino ansermino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just my two cents 🦐

docs/docs/users/filecoin_services.md Outdated Show resolved Hide resolved
Comment on lines +43 to +44
- [calibnet](https://github.com/ChainSafe/forest/blob/main/build/bootstrap/calibnet)
- [mainnet](https://github.com/ChainSafe/forest/blob/main/build/bootstrap/mainnet)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [calibnet](https://github.com/ChainSafe/forest/blob/main/build/bootstrap/calibnet)
- [mainnet](https://github.com/ChainSafe/forest/blob/main/build/bootstrap/mainnet)
#### Mainnet
- `/dns/bootstrap-mainnet-0.chainsafe-fil.io/tcp/34000/p2p/12D3KooWKKkCZbcigsWTEu1cgNetNbZJqeNtysRtFpq7DTqw3eqH`
- `/dns/bootstrap-mainnet-1.chainsafe-fil.io/tcp/34000/p2p/12D3KooWGnkd9GQKo3apkShQDaq1d6cKJJmsVe6KiQkacUk1T8oZ`
- `/dns/bootstrap-mainnet-2.chainsafe-fil.io/tcp/34000/p2p/12D3KooWHQRSDFv4FvAjtU32shQ7znz7oRbLBryXzZ9NMK2feyyH`
#### Calibnet
- `/dns/bootstrap-calibnet-0.chainsafe-fil.io/tcp/34000/p2p/12D3KooWABQ5gTDHPWyvhJM7jPhtNwNJruzTEo32Lo4gcS5ABAMm`
- `/dns/bootstrap-calibnet-1.chainsafe-fil.io/tcp/34000/p2p/12D3KooWS3ZRhMYL67b4bD5XQ6fcpTyVQXnDe8H89LvwrDqaSbiT`
- `/dns/bootstrap-calibnet-2.chainsafe-fil.io/tcp/34000/p2p/12D3KooWEiBN8jBX8EBoM3M47pVRLRWV812gDRUJhMxgyVkUoR48`
- `/dns/bootstrap-archive-calibnet-0.chainsafe-fil.io/tcp/1347/p2p/12D3KooWLcRpEfmUq1fC8vfcLnKc1s161C92rUewEze3ALqCd9yJ`

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid embedding copying those entries, as they might change over time and Forest docs should not be a source of truth - the code should.

### Bootstrap nodes

Bootstrap nodes are essential for new peers joining the network. They provide a list of known peers to connect to, allowing the new peer to join the network quickly. ChainSafe provides several bootstrap nodes (both Forest and Lotus-based) for the Filecoin network (the `chainsafe.io` domain):

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ChainSafe also operates an **archival bootstrap node** which maintains a full set of historical state to serve to the network.

We should mention this somewhere/how. This suggestion can probably be expanded/improved.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joshdougall Can you provide some details around it?


### Storage

The S3-compatible IPFS/Filecoin gateway is available at [storage.chainsafe.io](https://storage.chainsafe.io).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joshdougall Would be good to include some direction for where to go for support (eg. Fil slack channels)


ChainSafe works on various projects in the Filecoin ecosystem. While the Forest team focuses on improving the Forest client and collaborating with other Filecoin implementations to drive the network forward, ChainSafe's Infrastructure team provides a number of services to the Filecoin community.

## 🌲Forest
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure it makes sense for Forest to be at the top of this, nor to separate services into forest vs infra. The purpose of this page is to promote the services we operate, shilling Forest should be secondary. Also the distinction of what each team operates is probably not relevant to users (unless they have issues...)

I would suggest mentioning Forest in a callout (ie. admonition, :::info....), collapsing this into a single list, and moving the status page to a callout as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also the distinction of what each team operates is probably not relevant to users (unless they have issues...)

That's the exact reason for this distinction, given folks were quite often reaching out to Forest team, and the only thing we could do is to forward it to the infra team. It's not a huge hassle, though.

I can de-prioritize Forest in this page.

<img src="/img/filecoin_logo.png" alt="Filecoin logo"/>
</p>

ChainSafe works on various projects in the Filecoin ecosystem. While the Forest team focuses on improving the Forest client and collaborating with other Filecoin implementations to drive the network forward, ChainSafe's Infrastructure team provides a number of services to the Filecoin community.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ChainSafe works on various projects in the Filecoin ecosystem. While the Forest team focuses on improving the Forest client and collaborating with other Filecoin implementations to drive the network forward, ChainSafe's Infrastructure team provides a number of services to the Filecoin community.
ChainSafe works on various projects in the Filecoin ecosystem. While the Forest team focuses on improving the Forest client and collaborating with other Filecoin implementations to drive the network forward, ChainSafe's Infrastructure team provides a number of services to support the Filecoin community, dogfooding Forest at every possible opportunity.

@LesnyRumcajs
Copy link
Member Author

@ansermino Changed it a bit to address some of your comments (mainly regarding the page being Forest-centric).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants