docs: improve checks documentation - fix typos, links, and grammar#228
Draft
BigLep wants to merge 14 commits intodocs/whats-it-doingfrom
Draft
docs: improve checks documentation - fix typos, links, and grammar#228BigLep wants to merge 14 commits intodocs/whats-it-doingfrom
BigLep wants to merge 14 commits intodocs/whats-it-doingfrom
Conversation
… flow - Add explanation that overall deal status depends on Upload, Onchain, Discoverability, and Retrieval sub-statuses - Document branching flow: Upload → (Onchain ∥ Discoverability) → Retrieval - Add multiple diagram options showing the dependency structure - Update assertions table with retries and metric references - Add production configuration and approval methodology doc
- Add README.md to checks directory with overview and terminology - Move 'What is DealBot?' section to README - Add MIN_NUM_DATASETS_FOR_CHECKS to configuration table with description - Clean up incomplete FAQ entries in data-storage.md - Add link to filecoin-pin FAQ for filecoinpin.contact vs cid.contact - Add SP maintenance window section to production config doc - Add check frequency information to production config doc - Fix metric name typo (dataStorageCheckMs -> retrievalCheckMs)
- Fix typos: instnace→instance, appropraite→appropriate, verificaiont→verification, etc. - Fix broken anchor links in data-storage.md - Fix grammar: dealbot confirm→confirms, already knows→know, etc. - Remove TBD_VARIABLE placeholders and TODO comments - Fix missing closing backticks in formulas - Fix duplicate words and double spaces - Standardize terminology and fix inconsistent section references - Fix metric name typos and broken event links in events-and-metrics.md - Complete incomplete sentences and fix punctuation
Add details about checkType and providerId labels/attributes for filtering metrics
Contributor
Author
|
@SgtPooki : I need to look at this with a clear head to catch my own mistakes before I take up your head, but this is where my head has been at. I spent the most time thinking about the events and metrics doc. It got me thinking that it would be good to just have prometheus metrics for all the metrics (assuming we have a label/attribute for providerId and checkType). It would make it easy to display things in Grafana and do either SP-focused views or look across all SPs. Next steps:
|
Replace SP-under-test and SP under testing with SP under test / SPs under test throughout.
…rability Show Upload → Onchain and Discoverability in parallel, then Retrieval only after Discoverability succeeds; deal success requires both Onchain and Retrieval.
- bandwith → bandwidth - Link Data Storage Check and Retrieval Check to data-storage.md and retrievals.md
…ions - Use pieceConfirmedOnChainMs and spIndexLocallyMs for assertions 3 and 4 - Set assertion 2 metric to n/a (no matching metric in events-and-metrics)
Column links to sub-status meanings and maps each assertion to Upload, Onchain, Discoverability, or Retrieval.
- events-and-metrics: fix 'metrics results' wording, Emmitted→Emitted, remove empty bullet, fix table cell - retrievals: subject-verb agreement (remain), 'on 5xx response' - production-config: clarify RANDOM_PIECE_SIZES note for retrieval downloads
Contributor
Author
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR has the set of things that I would want to change / improve or discuss improving on #164