-
Notifications
You must be signed in to change notification settings - Fork 459
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] Dedicated docs on how to skip building an image on pipeline run #3079
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no change to toc.md?
I think we need to talk about this in a sync way
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Hamza Tahir <hamza@zenml.io>
Good catch @htahir1, i updated the toc and added other changes. open to chatting whenever you have time |
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
apart from my comments, id point you to this SDK docs page:
I like how this frames it as the "build process". I think what we need is to split up into two chapters:
-
How to reuse a build (the only mention we have of the build id is https://docs.zenml.io/how-to/use-configuration-files/what-can-be-configured#build-id and https://docs.zenml.io/how-to/customize-docker-builds/use-code-repositories-to-speed-up-docker-build-times and maybe https://docs.zenml.io/how-to/customize-docker-builds/docker-settings-on-a-pipeline .
Here i'd take about what a build even is , and tell people how you can use a build_id to reuse it, and that code repos and artifact store uploads automate that part of it -
How to use an existing image / How to skip that zenml builds your image: This is what you have tackled here.
In addition to all this feedback, id love what @schustmi has to say about this
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
@wjayesh what about my suggestion to split into more pages ? |
@htahir1 i agree with it and will be adding it before i request your review again |
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As you did a move now, we need a redirect from the yaml file
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah so i think there is a fundamental misunderstanding here about whether the code should be inside or outside the image, but aside from that we're on a good track
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok way better! Just one small thing but otherwise approved!
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/how-to-reuse-builds.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/customize-docker-builds/use-a-prebuilt-image.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Describe changes
I added documentation detailing how to skip building an image every time a pipeline is run.
It includes:
Pre-requisites
Please ensure you have done the following:
develop
and the open PR is targetingdevelop
. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes