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

Use proper names when referencing indexer abstractions #643

Closed
ra0x3 opened this issue Mar 13, 2023 · 3 comments
Closed

Use proper names when referencing indexer abstractions #643

ra0x3 opened this issue Mar 13, 2023 · 3 comments
Assignees

Comments

@ra0x3
Copy link
Contributor

ra0x3 commented Mar 13, 2023

  • We need to go throughout the codebase and rename things for clarity

  • These things include routes, migrations, table fields, variables, etc...everything

  • Definitions

    • Indexer: an abstraction that takes Fuel-VM data and produces indices
    • Indexer service: A service that runs one or more indexers
    • Executors: async tasks run by indexers
    • Indices: data produced by an indexer
  • Everywhere we're referencing "index" we need to most likely replace with "indexer"

    • If we don't do this, we're creating confusion, as an "index" is the resultant data produced by an "indexer"
  • This will most likely require migrations for name changes to tables and such

@ra0x3 ra0x3 added the chore label Mar 13, 2023
@deekerno
Copy link
Contributor

@ra0x3 What do you think about adding a glossary to our book as part of the documentation cleanup for this milestone? I feel that it may be helpful to have a page to refer users (and perhaps ourselves) to when they have questions about the terminology.

@ra0x3
Copy link
Contributor Author

ra0x3 commented Mar 13, 2023

@deekerno I think that would be super helpful. Like a section “Glossary” in the SUMMARY. It would be small for now but I think that’s fine

@deekerno
Copy link
Contributor

@ra0x3 Word. I'm finishing up the first pass of the documentation cleanup, so I'll make a quick page to knock it out as well as update the terminology in the book itself. 👌🏽

@ra0x3 ra0x3 self-assigned this Mar 15, 2023
deekerno added a commit that referenced this issue Mar 17, 2023
* Add blurb for optional schema fields

* Add bit about subscribing to changed contract

* Fixed sentence flow on optional schema field section

* Remove deprecated --background flag on forc index start

* Add identifier to block explorer example query

* Address #579 by re-adding index pages on offending sections

* Add link about Mx WASM concerns to WASM dependency page

* Edits for clarity

* re: #643 -- s/index/indexer, where appropriate

* Add queries page; better to have more information than less

* Missed a s/index/indexer

* Add a glossary; inspiration taken from The Rust Book

* A bit more cleanup

* Clean up overall flow

* Add page for forc index revert

* Remove unused pages

* Address rvmelkonian feedback

* add examples for handling receipt types

* Small typo fix

* Remove outdated Fuel logos

* small updates

* Remove link to Queries page for now

---------

Co-authored-by: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com>
Co-authored-by: Rashad Alston <rashad@Rashads-MacBook-Pro.local>
@ra0x3 ra0x3 removed the chore label Aug 8, 2023
@ra0x3 ra0x3 closed this as completed Sep 12, 2023
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

No branches or pull requests

2 participants