docs: lead with the command that works, and correct a wrong claim - #22
Merged
Conversation
The published image pulls anonymously — verified by logging out of the registry, removing the local copy, and running the reported command, then the whole README flow against what came down: oxctl list, oxctl logs counter, curl, and a docker stop that exits in under a second. So the pull goes first. It is one command and needs no toolchain, which is what the section is for; building it yourself is the alternative, not the default. And a claim I wrote into ROADMAP while fixing the last problem was wrong: that a package pushed by Actions is private by default and would need a manual visibility change. It is not, for a package pushed from a public repository — it inherits the repository's visibility. Corrected in place rather than deleted, because the lesson is the same one the bug taught, applied to the fix: reasoning about what a command will do is not the same thing as running it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The published image pulls anonymously. Verified by logging out of the
registry, removing the local copy, and running the reported command —
then the whole README flow against what came down:
oxctl list,oxctl logs counteranddocker stop(exit 0, under asecond) all work from the pulled image.
So the pull goes first. One command, no toolchain — which is what that
section exists for. Building it yourself is the alternative.
A correction
I wrote into ROADMAP, while fixing the previous problem, that a package
pushed by Actions is private by default and would need a manual
visibility change. That is wrong for a package pushed from a public
repository: it inherits the repository's visibility.
Corrected in place rather than deleted, because the lesson is the one the
original bug taught, applied to the fix — reasoning about what a command
will do is not the same as running it.