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.

Sign up for GitHub

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

Jump to bottom

cmd/multinode: Add further documentation #4556

Merged
merged 1 commit into from
Feb 22, 2022
Merged

cmd/multinode: Add further documentation #4556

merged 1 commit into from
Feb 22, 2022

Conversation

Sembeth
Copy link
Contributor

@Sembeth Sembeth commented Feb 21, 2022 •
edited by stefanbenten

The text has been expanded a bit to clarify that it is necessary to create identity files with an example before using the Docker image.
Changed the placeholder to so no one confuses them with the storagenode identity files.
Changed the placeholder to so no one confuses them with the storagenode 'config' folder.

fixed #4547

Code Review Checklist (to be filled out by reviewer)

  • NEW: Are there any Satellite database migrations? Are they forwards and backwards compatible?
  • Does the PR describe what changes are being made?
  • Does the PR describe why the changes are being made?
  • Does the code follow our style guide?
  • Does the code follow our testing guide?
  • Is the PR appropriately sized? (If it could be broken into smaller PRs it should be)
  • Does the new code have enough tests? (every PR should have tests or justification otherwise. Bug-fix PRs especially)
  • Does the new code have enough documentation that answers "how do I use it?" and "what does it do?"? (both source documentation and higher level, diagrams?)
  • Does any documentation need updating?
  • Do the database access patterns make sense?

@Sembeth Sembeth requested a review from a team February 21, 2022 23:49
@cla-bot
Copy link

cla-bot bot commented Feb 21, 2022

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @Sembeth on file. Once you have signed the CLA, please let us know, so we can manually review and add you to the approved contributors list.

@Sembeth
Copy link
Contributor Author

Sembeth commented Feb 21, 2022

@cla-bot check

@cla-bot cla-bot bot added the cla-signed label Feb 21, 2022
@cla-bot
Copy link

cla-bot bot commented Feb 21, 2022

The cla-bot has been summoned, and re-checked this pull request!

@Sembeth @egonelbre
cmd/multinode: Add further documentation
f4ff01a 
The text has been expanded a bit to clarify that it is necessary to create identity files with an example before using the Docker image.
Changed the <identity-dir> placeholder to <multinode-identity-dir> so no one confuses them with the storagenode identity files.
Changed the <storage-dir> placeholder to <multinode-config-dir> so no one confuses them with the storagenode 'config' folder.

fixed storj#4547
@stefanbenten stefanbenten merged commit d015805 into storj:main Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@egonelbre egonelbre egonelbre approved these changes

@stefanbenten stefanbenten stefanbenten approved these changes

Assignees
No one assigned
Labels
cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Multinode Dashboard: Docker Image
3 participants
@Sembeth @egonelbre @stefanbenten