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] Dedicated docs on how to skip building an image on pipeline run #3079

Merged
merged 26 commits into from
Oct 18, 2024

Conversation

wjayesh
Copy link
Contributor

@wjayesh wjayesh commented Oct 14, 2024

Describe changes

I added documentation detailing how to skip building an image every time a pipeline is run.

It includes:

  • how to do it
  • what the image should contain and how to build it
  • where users can use this feature

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@wjayesh wjayesh requested a review from htahir1 October 14, 2024 09:57
@wjayesh wjayesh changed the title [docs[ Dedicated docs on how to skip building an image on pipeline run [docs] Dedicated docs on how to skip building an image on pipeline run Oct 14, 2024
@github-actions github-actions bot added internal To filter out internal PRs and issues documentation Improvements or additions to documentation labels Oct 14, 2024
Copy link
Contributor

@htahir1 htahir1 left a 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

@wjayesh wjayesh requested a review from htahir1 October 14, 2024 12:22
@wjayesh
Copy link
Contributor Author

wjayesh commented Oct 14, 2024

Good catch @htahir1, i updated the toc and added other changes. open to chatting whenever you have time

Copy link
Contributor

@htahir1 htahir1 left a 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:
image

I like how this frames it as the "build process". I think what we need is to split up into two chapters:

In addition to all this feedback, id love what @schustmi has to say about this

@htahir1
Copy link
Contributor

htahir1 commented Oct 15, 2024

@wjayesh what about my suggestion to split into more pages ?

@wjayesh
Copy link
Contributor Author

wjayesh commented Oct 15, 2024

@htahir1 i agree with it and will be adding it before i request your review again

Copy link
Contributor

@htahir1 htahir1 left a 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

Copy link
Contributor

@htahir1 htahir1 left a 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

Copy link
Contributor

@htahir1 htahir1 left a 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!

@wjayesh wjayesh requested a review from strickvl October 17, 2024 12:14
Co-authored-by: Alex Strick van Linschoten <[email protected]>
@wjayesh wjayesh requested a review from strickvl October 17, 2024 12:48
@wjayesh wjayesh merged commit f4503f9 into develop Oct 18, 2024
9 checks passed
@wjayesh wjayesh deleted the docs/docker-skip-build branch October 18, 2024 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants