doc: Improve --replace-indexer message when redeploying an indexer

FuelLabs / fuel-indexer

🗃 The Fuel indexer is a standalone service that can be used to index various components of the Fuel blockchain.

https://docs.fuel.network/docs/indexer/

140 stars 66 forks source link

doc: Improve --replace-indexer message when redeploying an indexer #1504

Closed richardgreg closed 5 months ago

richardgreg commented 7 months ago

close #1461

Thanks for opening a PR with the Fuel Indexer project. Please review the Checklist below and ensure you've completed all of the necessary steps to make this PR review as painless as possible.

Checklist

[x] Ensure your top-level commit message is in line with our contributor guidelines.
[x] Please add proper labels.
[ ] If there is an issue associated with this PR, please link the issue (right-hand sidebar)
[ ] If there is not an issue associated with this PR, add this PR to the "Fuel Indexer" project (right-hand sidebar)
[ ] Please allow Codeowners at least 24 hours to do a first-pass review.
[ ] Please add thoroughly detailed testing steps below.
[ ] Please keep your Changelog message short and sweet.

Description

Please include a short description of what this PR does.

Testing steps

Please provide the exact testing steps for the reviewer(s) if this PR requires testing.

Changelog

Please add neat Changelog info here, according to our Contributor's Guide.

richardgreg commented 7 months ago

I get it. I was originally working on it based on intuition and didn't read the docs. 😓

I'll push a fix ASAP

richardgreg commented 7 months ago

Also @deekerno, some clarification on the instruction before I push an update. 😊

If a user enters forc index deploy --replace-index in a situation whereby --replace-index was not stated when the service was ran, the error message should read: Failed to replace indexer: Indexer({namespace}.{identifier}) exists but replacing the indexer was not enabled. Restart the indexer service with --replace-indexer to enable the functionality.

If a user enters forc index deploy in a situation whereby --replace-index was not stated when the service was ran, the error message should read: Indexer({namespace}.{identifier}) already exists and replacing an indexer is not enabled. Use --replace-indexer to restart the indexer service and again during deployment.

richardgreg commented 5 months ago

Hi @deekerno, I'm not one to abandon work so I'm curious why the PR was closed without resolution 🙂. I hadn't pushed an update because you never okayed my suggestion. If you have an ideal text replacement in mind, paste it and I'll update it.

deekerno commented 5 months ago

@richardgreg I've closed all open PRs on this repository as we're starting work on a new implementation of the Fuel indexer. The closure of this PR was purely because of the team's decision to focus all of our energy on the new implementation, and not because of any deficiency on the part of your contribution. As we build out the next iteration (the code for which can be found here), please feel free to make contributions if you like.