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

Documentation for Boost v2 (LID information) #1453

Closed
12 of 16 tasks
nonsense opened this issue May 17, 2023 · 4 comments
Closed
12 of 16 tasks

Documentation for Boost v2 (LID information) #1453

nonsense opened this issue May 17, 2023 · 4 comments
Assignees

Comments

@nonsense
Copy link
Member

nonsense commented May 17, 2023

    • Add variants to Documentation
      • We want 2 variants for http://boost.filecoin.io/ – one for stable release, and one for unreleased / master version. Coordinate with Mayank and fix DNS / Gitbook for it.
    • Changes to unrelease variant of Documentation
      • Tutorial for upgrading from Boost v1 to Boost v2
      • Explanation of boostd-data and how it interacts with YugabyteDB and LevelDB
      • Maybe add Deployment page that explains a full deployment and all processes of Boost (boostd, boostd-data, http, bitswap, lotus, lotus-miner, etc.) (currently this is Getting Started -> As a SP)
      • Add more docs on YugabyteDB – not a full copy-paste of YugabyteDB docs, but some explanation how to get started with it.
      • Downgrade Lotus -> Boost upgrade into a not-so-central page
      • Add documentation page on Storage- and Retrieval- in general why it is important for Retrieval- to be up and running (i.e. incentives, FIL+ data, Spade reputation, etc.)
      • Document that the connection to the LID service must be a websocket connection (not http)
      • Document what “unsealed”, “sealed”, “indexing” means
@nonsense nonsense self-assigned this May 17, 2023
@nonsense nonsense added this to Boost May 17, 2023
@nonsense nonsense moved this to In Progress in Boost May 17, 2023
@nonsense nonsense changed the title docs page on LID / migrate / recovery tool Documentation for Boost v2 May 29, 2023
@LexLuthr
Copy link
Collaborator

LexLuthr commented May 30, 2023

Please add the following as well:

  • Boost component overview - All binaries and what they do along with how they connect to each other
  • How Boost talks to lotus - boundary between Boost, Miner and daemon
  • All exposed ports and what they are used for - all security considerations
  • Getting familiar with Boost UI - What each page contains and how to look up things
  • How retrievals work - all 3 protocols showing where data comes from

@brendalee
Copy link
Collaborator

An additional item to consider (mostly for LID migration documentation) - after talking to Rob, could start compiling a list of FAQs on migration tooling.

For example:

  • Do I need to run the migration in one go, or do I have an option to do it incrementally?
  • Can I still make storage deals while doing the migration to LID?

@brendalee
Copy link
Collaborator

Please add the following as well:

  • Boost component overview - All binaries and what they do along with how they connect to each other
  • How Boost talks to lotus - boundary between Boost, Miner and daemon
  • All exposed ports and what they are used for - all security considerations
  • Getting familiar with Boost UI - What each page contains and how to look up things
  • How retrievals work - all 3 protocols showing where data comes from

I'm going to separate out these documentation items as additional docs improvements, and not LID related documentation

@brendalee brendalee changed the title Documentation for Boost v2 Documentation for Boost v2 (LID information) Jun 8, 2023
@brendalee
Copy link
Collaborator

Issue created here: #1504

@github-project-automation github-project-automation bot moved this from In Progress to Done in Boost Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants