project-copacetic / copacetic

🧵 CLI tool for directly patching container images!
https://project-copacetic.github.io/copacetic/
Apache License 2.0
960 stars 63 forks source link

[DOC] Update development tips SolveToDocker reference #671

Closed ashnamehrotra closed 2 months ago

ashnamehrotra commented 3 months ago

What kind of documentation improvement is needed?

None

What is the change that is needed?

The buildkit.SolveToDocker() function referenced here was removed in #181. It would be helpful to update the documentation to include the function for users to use for debugging purposes.

Are you willing to submit PRs to contribute to documentation?

shishir-11 commented 2 months ago

I'm confused on what changes in the documentation is required, does the function no longer work and another function needs to be mentioned , if it still works then is the current documentation not sufficient ?

ashnamehrotra commented 2 months ago

@shishir-11 The function was removed from the code in #181, however the documentation still references it. buildkit.SolveToDocker was copa's custom function. It would be helpful to document the function in copa's website so users can add it in to help with dev/testing as needed.

shishir-11 commented 2 months ago

I'm unable to find the changes to the buildkit.go or test file in #181 ,please correct me if I'm looking in the wrong place. I'd also like to know why it was removed and if some other method to do a similar action was put in its place.

ashnamehrotra commented 2 months ago

@shishir-11 sorry, this was supposed to be #381 (line 185 before it got removed since it was unused)

shishir-11 commented 2 months ago

please check it out and point out any mistakes I might have made, Thanks.