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

Refreshing Documentation #612

Merged
merged 13 commits into from May 2, 2024
Merged

Refreshing Documentation #612

merged 13 commits into from May 2, 2024

Conversation

gauryvg98
Copy link
Collaborator

@gauryvg98 gauryvg98 commented Apr 26, 2024

No description provided.

Copy link
Collaborator

@devyetii devyetii left a comment

Choose a reason for hiding this comment

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

Good work, @gauryvg98. Thanks. Just a couple of points left:

  • Please add output response example for alloc-cancel, alloc-fini, list-all, bl-update, update,
  • Please make sure that the command revoke works only for --encrypted files as mentioned in the docs.
  • Please add example to the list command using auth ticket
  • Please re-check the sync and get-diff command by running it locally and make sure it's working as expected. If you already did that, please mention.
  • Please hide add, sync, get-diff, stream, get-mpt, recent-refs, reset-blobber-stats. Add their existing documentation in README.md to internal.md in the root of the repo.
  • Please move streaming documentation from the README file to internal.md
  • Ensure the validity of this statement mentioned in the docs: "If the stake pool cannot be unlocked as it would leave insufficient funds for opened offers, then sp-unlock tags the stake pool to be unlocked later."
  • The command wp-info is removed. Please remove all related docs.
  • It's mentioned that "wp-unlock unlocks an expired write pool." Please verify this statement, that we cannot unlock a write pool for an allocation that's not expired (or cancelled).
  • Please add documentation to createdir, decrypt, get-mpt, list-all, rollback, validator-update, shutdow-blobber, shutdown-validator. For rollback I believe you'll need to check the code. Let me know if you need support.

@devyetii
Copy link
Collaborator

@gauryvg98 Edit for the above comment: please hide rollback command and add simple comment on it in the internal.md file.

@gauryvg98
Copy link
Collaborator Author

gauryvg98 commented Apr 28, 2024

Tested -

  1. command revoke works only for --encrypted files as mentioned in the docs. - working
  2. re-check the sync and get-diff - working
  3. wp-unlock unlocks an expired write pool." Please verify this statement - expected behavior

Couldn't test :

  1. "If the stake pool cannot be unlocked as it would leave insufficient funds for opened offers, then sp-unlock tags the stake pool to be unlocked later."

  2. bl-update

Copy link
Collaborator

@devyetii devyetii left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@dabasov dabasov left a comment

Choose a reason for hiding this comment

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

lgtm

@dabasov dabasov merged commit 6e1445f into sprint-1.14 May 2, 2024
6 checks passed
@dabasov dabasov deleted the doc/update branch May 2, 2024 13:01
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

Successfully merging this pull request may close these issues.

None yet

3 participants