Skip to content

Update MinIO documentation #585

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update MinIO documentation #585

wants to merge 6 commits into from

Conversation

dani-garcia
Copy link
Member

@dani-garcia dani-garcia commented May 14, 2025

🎟️ Tracking

📔 Objective

Updated the documentation to include an image of bucket creation and to better reflect the access rules setup in the newest MinIO version. Specifically, the prefix for the access rule needs to be / instead of *, as MinIO will automatically append a * now, as shown by this dialog:
image

Added some documentation on how to test the rollout process, explaining how to configure a published release to use a staged rollout, and how to ensure that a specific client belongs/doesn't belong to the rollout.

Also added some troubleshooting steps in case the publish fails. In my case ZScaler was causing using the same port as MinIO, so I've written a small guide on how to choose a different port.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link

github-actions bot commented May 14, 2025

Logo
Checkmarx One – Scan Summary & Detailsd2ea75f3-d220-4d41-984e-cc3092a3abdb

Great job, no security vulnerabilities found in this Pull Request

Copy link

cloudflare-workers-and-pages bot commented May 14, 2025

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 815563f
Status:🚫  Deploy failed.

View logs

@dani-garcia dani-garcia marked this pull request as ready for review May 14, 2025 13:33
@dani-garcia dani-garcia requested a review from a team as a code owner May 14, 2025 13:33
Copy link
Member

@Hinton Hinton left a comment

Choose a reason for hiding this comment

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

Looks good some minor nits.

@dani-garcia dani-garcia requested a review from Hinton May 22, 2025 11:52
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.

2 participants