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

docs: remove link to external docker image #599

Merged
merged 1 commit into from May 24, 2023
Merged

Conversation

dpopp07
Copy link
Member

@dpopp07 dpopp07 commented May 24, 2023

There is a community-supported Docker image for running this tool. It is not known to be compromised in any way but it is against our security policies to link to an image controlled by an external agent, so this commit removes the section of the README linking to the external image.

We will likely look into hosting our own image in the future.

This also adds an NPM script for formatting the README's table of contents. The README previously instructed the user to run an NPM package; this way, they don't have to install anything.

There is a community-supported Docker image for running this tool. It is not known to be
compromised in any way but it is against our security policies to link to an image
controlled by an external agent, so this commit removes the section of the README linking
to the external image.

We will likely look into hosting our own image in the future.

This also adds an NPM script for formatting the README's table of contents. The README
previously instructed the user to run an NPM package; this way, they don't have to
install anything.

Signed-off-by: Dustin Popp <dpopp07@gmail.com>
@dpopp07 dpopp07 requested a review from padamstx May 24, 2023 17:19
Copy link
Member

@padamstx padamstx left a comment

Choose a reason for hiding this comment

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

LGTM

@dpopp07 dpopp07 merged commit 75c5db0 into main May 24, 2023
4 checks passed
@dpopp07 dpopp07 deleted the dp/remove-docker-link branch May 24, 2023 19:14
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.1.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.1.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.1.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

None yet

3 participants