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

fix: missing enumerated values in generated docs for warehouse #2969

Merged
merged 2 commits into from
Nov 20, 2024

Conversation

fykaa
Copy link
Contributor

@fykaa fykaa commented Nov 20, 2024

closes #2880

doc ref: #2963

Signed-off-by: Faeka Ansari <[email protected]>
@fykaa fykaa self-assigned this Nov 20, 2024
@fykaa fykaa requested a review from a team as a code owner November 20, 2024 12:44
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for docs-kargo-io ready!

Name Link
🔨 Latest commit f153333
🔍 Latest deploy log https://app.netlify.com/sites/docs-kargo-io/deploys/673dd9981332eb0008205de3
😎 Deploy Preview https://deploy-preview-2969.docs.kargo.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.91%. Comparing base (547f686) to head (f153333).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2969   +/-   ##
=======================================
  Coverage   50.91%   50.91%           
=======================================
  Files         279      279           
  Lines       25175    25175           
=======================================
  Hits        12818    12818           
  Misses      11666    11666           
  Partials      691      691           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@@ -67,6 +67,7 @@ type WarehouseSpec struct {
// FreightCreationPolicy describes how Freight is created by this Warehouse.
// This field is optional. When left unspecified, the field is implicitly
// treated as if its value were "Automatic".
// Accepted values: Automatic, Manual
Copy link
Member

Choose a reason for hiding this comment

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

Nice catch. I overlooked this.

@krancour krancour added this to the Live Docs milestone Nov 20, 2024
@krancour
Copy link
Member

This is a good start. I'll approve because I'd like to see this information out into the real world sooner rather than later, but we should follow-up in the very near future to document the behavior of each of those strategies.

@krancour krancour added this pull request to the merge queue Nov 20, 2024
Merged via the queue into akuity:main with commit 27f501c Nov 20, 2024
24 checks passed
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
@akuitybot
Copy link

Successfully created backport PR for release-1.0:

@fykaa
Copy link
Contributor Author

fykaa commented Nov 20, 2024

we should follow-up in the very near future to document the behavior of each of those strategies.

this PR tries to talk about the behavior of each strategy

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

Successfully merging this pull request may close these issues.

Document the possible values of Warehouse imageSelectionStrategy
3 participants