mirror of
https://github.com/buckit-io/buckit.git
synced 2026-09-12 05:49:02 +00:00
abuckit
6a4de45bbe
* docs: retitle the Docker section to match what it does The section was called "Build Docker Image" but was almost entirely about running the published one, so anyone scanning for how to try Buckit in a container skipped past it. Retitle to "Run with Docker", lead with the run commands, and demote image building to a closing note. Also name both registries and the advice to pin a tag in production. * docs: make Quickstart reach a running server in one command Quickstart opened with `make build`, so the first runnable thing in the README required installing Go and compiling. Lead with the published container image instead. Fold Distributed Server Mode in as a subsection so the single-node and cluster commands sit together. The cluster one-liner is the more striking of the two and was previously buried under prose, split across continuation lines, and immediately followed by advice to use bm web instead. It now stands on its own line with an explanation of what it describes. * docs: quickstart without requiring Docker Leading with a container image assumed a runtime the reader may not have. The binary installer shipped in the last release needs neither a toolchain nor Docker, so use that instead and keep the container path as one of the alternatives listed beneath it. * docs: split quickstart into download and run steps * docs: walk the quickstart through to an uploaded file The quickstart stopped at a running process, which is not the thing a reader is trying to confirm. Continue through signing in to the console and uploading an object with bm, so the first session ends with data in object storage rather than a server listening on a port. * docs: tighten the quickstart and end it in the console Cut the throat-clearing: the "no toolchain required" claim, the description of what the installer does, and the pointers to other install methods, which are one heading away. Swap the last two steps. Creating a bucket and uploading a file, then opening the console to find them there, gives the sequence a payoff. The previous order treated the console and the CLI as interchangeable alternatives, which ended the quickstart on a shrug. * docs: give quickstart steps their own headings Bold-inline step labels ran into the text that followed them, so the four steps read as one block. Promote them to h3 so each gets real separation and an anchor, and move the platform variants and the bm install note into the code blocks as comments, where a reader can copy the line that applies to them instead of reading a sentence about it. The cluster one-liner becomes its own section rather than a fifth sibling heading under Quickstart, where it read as step 5. * docs: restore the learning-purposes note on the quickstart * docs: reword the quickstart note * docs: state what the quickstart walks through * docs: put the quickstart note above the intro line * docs: point the quickstart note at the guided deployment wizard * docs: comment each command in the quickstart upload step * docs: note the PATH line is conditional * docs: name the data directory in the quickstart * docs: name the CLI in the step 3 heading * docs: say web browser rather than console in step 4 * docs: point at the Object Browser menu in step 4 * docs: give the Windows bm install its own line * docs: comment out the Windows bm install so the block pastes cleanly * docs: restore the Distributed Server Mode heading * docs: restore the original Distributed Server Mode section * docs: keep the rewritten distributed section under its original heading * docs: restore Distributed Server Mode to its original form * docs: point distributed deployments at the guided wizard * docs: simplify what the wizard handles * docs: simplify the install section blurbs * docs: drop the Linux install subsections from Install Buckit Installing and deploying for real takes more than a one-line curl, and the Deployment Guide covers it properly. The quickstart already shows the download command for anyone who just wants to try the server, so these two sections offered a third telling of the same thing at a level of detail that suits neither audience. Leaves Install Buckit as a pointer to the guide, plus building from source, which is the part only this repository can document. * docs: contrast the deployment guide with building from source * docs: promote Build From Source to a top-level section * docs: drop the build commands that do not work `go install github.com/buckit-io/buckit@latest` cannot succeed. Go refuses `pkg@version` installs for any module carrying a replace directive, and go.mod:7 has one for go-openapi/testify. The line was inherited from MinIO's README, where it works because their go.mod has none. Running it here fails outright. The manual `go build -tags kqueue -trimpath --ldflags ...` line was the Makefile's build target spelled out, so it only offered a way to get the invocation subtly wrong. Leaves the one path that works, verified from a clean clone. * docs: restore go install now that it works Removing it was correct at the time: the go.mod replace directive made `go install pkg@version` fail outright. That directive is gone, and the command has been verified against the published module. Note the version caveat -- go install skips the Makefile's gen-ldflags step, so the binary cannot report which release it came from. * docs: use the Docker Hub image in the run commands Docker Hub is Docker's default registry, so buckitio/buckit needs no prefix at all, and it is where most people expect to find an image. This also matches the compose example in the migration blog post. Name both registries explicitly in the note beneath, since GHCR is not subject to Docker Hub's anonymous pull limits and is the better choice from CI. * docs: drop the custom-image aside from Run with Docker * docs: name the bm section as the CLI * docs: add a Buckit Manager Web screenshot The section described a web UI without showing it. Use the cluster view from the website's media assets, which covers four of the five things the section lists: cluster health, nodes, pools and drives, and host operations. Cropped off the decorative video-poster frame and the burned-in caption so it reads as a screenshot rather than a video thumbnail. Placed centred under the intro, matching the console GIF at the top of the file. * docs: fold the bm install blocks into one Two blocks with prose labels became one with per-command comments, matching how the quickstart presents the same install. The Windows line is commented out so the block still pastes cleanly on Linux and macOS, where the trailing `bm --help` runs either way. * docs: add the PATH line the bm install block was missing `bm --help` fails with "bm: not found" straight after install: bm lands in ~/.local/bin and its installer only prints a PATH hint rather than applying one. The two blocks this replaced had the same gap. Verified by pasting the block verbatim with nothing added.
