Skip to content

Update README.md to add examples and configurations table. #469

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

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

shehrozsheikh
Copy link
Contributor

What's New:

  1. Example for Syncing MinIO with AWS S3

    • Added an example in the README.md to demonstrate how to sync MinIO with an AWS S3 bucket.
    • Since AWS S3 is widely used, this example should help others avoid the trial-and-error process I went through. Hopefully, it saves time and effort for anyone setting this up.
  2. Detailed Configuration Table

    • Introduced a configuration table that lists all the available options with detailed descriptions.
    • Config comments in the file can be easy to overlook, so this table provides a clearer, centralized reference.

Why This?

These updates aim to make the setup process smoother and more user-friendly, especially for first-time users. Let me know if there’s anything else you'd like to see added or improved!

@sre-ci-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: shehrozsheikh

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@sre-ci-robot
Copy link
Collaborator

Welcome @shehrozsheikh! It looks like this is your first PR to zilliztech/milvus-backup 🎉

Copy link

mergify bot commented Nov 27, 2024

@shehrozsheikh Thanks for your contribution. Please submit with DCO, see the contributing guide https://github.com/milvus-io/milvus/blob/main/CONTRIBUTING.md#developer-certificate-of-origin-dco.

Copy link

mergify bot commented Nov 27, 2024

@shehrozsheikh Please associate the related issue to the body of your Pull Request. (eg. “issue: #”)

Updated README.md file to add an example of how to sync minio to AWS S3 bucket and added a configuration table with all the allows configurations and their details.

Signed-off-by: Shehroz Ahmed <[email protected]>
@wayblink
Copy link
Contributor

@shehrozsheikh Cheer for this commit, I believe many new users will like it.

@wayblink wayblink merged commit d837c4b into zilliztech:main Nov 28, 2024
2 of 3 checks passed
@wayblink
Copy link
Contributor

I may move these to docs/user_guide/ and put a link in README

@shehrozsheikh
Copy link
Contributor Author

Yep, for sure. Whatever you prefer, just didn't want others to go through the hit-and-trial method I went through.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants