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

Update Indexer Documentation to include data-dir and catchpoint details #891

Open
algobarb opened this issue Aug 24, 2022 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@algobarb
Copy link
Contributor

algobarb commented Aug 24, 2022

Is your addition related to a problem? Please describe.
The "Install the indexer documentation" (docs/run-a-node/setup/indexer) are missing some details from the recent indexer releases (since 2.13.x) regarding the mandatory data-dir and how to use the --catchpoint flag.

Describe the solution you'd like
The "docs/run-a-node/setup/indexer" Run the Indexer section examples should match the ones in algorand/indexer repo: https://github.com/algorand/indexer#database-updater
Add missing --data-dir
We should also include some details on catchpoint: https://github.com/algorand/indexer/blob/2.13.0/docs/DataDirectory.md#initialization

Describe alternatives you've considered
I would reach out to Lamprey team and Product for wording.

Additional context
https://developer.algorand.org/docs/run-a-node/setup/indexer/
Data Directory details: https://github.com/algorand/indexer/blob/2.13.0/docs/DataDirectory.md#initialization
Indexer README examples: https://github.com/algorand/indexer#database-updater

@algobarb algobarb added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 24, 2022
@algobarb algobarb added the documentation Improvements or additions to documentation label Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants
@algobarb and others