You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Ideally the in-UI and external documentation makes it clearer what should be included in each text/JSON block. We recommend enhancing documentation clarity for JSON field inputs across all work pool types by providing precise examples that reflect the required API or framework and aligning field names with their actual API counterparts, ensuring correct casing and format. This will help ensure accuracy and improve user experience.
Additional context
No response
The text was updated successfully, but these errors were encountered:
taylor-curran
changed the title
Correct or add network configuration docs for ECS work pool
Enhance Documentation Clarity for JSON Field Inputs for the ECS work pool and ideally across other Work Pool Types
May 7, 2024
taylor-curran
changed the title
Enhance Documentation Clarity for JSON Field Inputs for the ECS work pool and ideally across other Work Pool Types
Enhance documentation clarity for JSON field inputs for the ECS work pool and ideally across other work pool types
May 7, 2024
First check
Describe the issue
When a user goes in to add network connection information to their ECS worker, the UX is like:
When they click on the link to aws docs they are given the following JSON example:
^Notice a capital
S
forSubnets
.However, further research into AWS docs led me to
With respect to the Prefect ECS work pool, we employ boto3. The request that is happening under the hood is RunTask, so a lowercase
s
is used.The following worked for the user after extensive trial and error:
While adding the following addition to the base job template:
Describe the proposed change
Ideally the in-UI and external documentation makes it clearer what should be included in each text/JSON block. We recommend enhancing documentation clarity for JSON field inputs across all work pool types by providing precise examples that reflect the required API or framework and aligning field names with their actual API counterparts, ensuring correct casing and format. This will help ensure accuracy and improve user experience.
Additional context
No response
The text was updated successfully, but these errors were encountered: