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.

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

Overview for published Docker image contains non-applicable information #64

Open
javaducky opened this issue Mar 3, 2023 · 1 comment

Comments

@javaducky
Copy link
Contributor

The overview provided for the image in Dockerhub includes sections from README that do not apply to the image.

Should remove the "Local Installation" and "Library Usage" sections. The "Command usage" section should be modified as it describes the usage of the binary itself, which is not exactly how the image would be used.

@imiric
Copy link
Contributor

imiric commented Mar 7, 2023

Yeah, I suppose we should have custom documentation just for the Docker image.

Agree with removing the "Local Installation" and "Library Usage" sections. But the "Command Usage" section is still relevant, since the image entrypoint is xk6. Though we should change the examples that reference paths on the local filesystem, since those would have to be mounted in the container first.

@javaducky Do you have bandwidth to do these changes? Maybe propose a PR to this repo as a new document (README-docker.md?), and then we'll update the Docker Hub overview with it.

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

No branches or pull requests

2 participants