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

docs: Updates for Indexer 3.0.0 #1562

Merged
merged 3 commits into from
Aug 3, 2023
Merged

Conversation

winder
Copy link
Contributor

@winder winder commented Aug 3, 2023

Summary

Update documentation to reflect Indexer 3.0.0. References to Indexer writers have been removed or replaced with references to Conduit.

@winder winder requested review from algoanne and a team August 3, 2023 14:31
@codecov
Copy link

codecov bot commented Aug 3, 2023

Codecov Report

Merging #1562 (8b0e4bc) into develop (efe92f5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1562   +/-   ##
========================================
  Coverage    68.58%   68.58%           
========================================
  Files           37       37           
  Lines         7417     7417           
========================================
  Hits          5087     5087           
  Misses        1903     1903           
  Partials       427      427           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@tzaffi tzaffi left a comment

Choose a reason for hiding this comment

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

Just a couple of grammatical nits

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@algoanne algoanne left a comment

Choose a reason for hiding this comment

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

Only thing we should probably add is the note to guide people who used to be on 2.x to the migration guide. As is, they'll come here and be confused.

README.md Outdated Show resolved Hide resolved
@@ -322,13 +282,3 @@ When searching by an account, results are returned most recent first. The intent
For all other transaction queries, results are returned oldest first. This is because it is the physical order they would normally be written in, so it is going to be faster.

<!-- USAGE_END_MARKER_LINE -->

# Migrating from Indexer v1
Copy link
Contributor

Choose a reason for hiding this comment

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

We could have a "Migrating from Indexer 2.x" section here that just point to the Conduit version of that... And at least acknowledge that things were different in 2.x?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added something about this.

README.md Outdated Show resolved Hide resolved
winder and others added 2 commits August 3, 2023 15:57
@winder winder added the Enhancement New feature or request label Aug 3, 2023
@winder winder self-assigned this Aug 3, 2023
@winder winder merged commit a1b2e3e into algorand:develop Aug 3, 2023
5 of 6 checks passed
@winder winder deleted the will/indexer-3-docs branch August 3, 2023 21:42
Copy link
Contributor

@Eric-Warehime Eric-Warehime left a comment

Choose a reason for hiding this comment

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

+16 −1,325 🔥

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

Successfully merging this pull request may close these issues.

4 participants