Conversation
|
Hey @hunterachieng Please review my pr and share your feedback, See my quick walk through video here |
josephjclark
left a comment
josephjclark
left a comment
There was a problem hiding this comment.
This PR confused me a bit until I figured out what you were doing!
Generally I approve, I think it's great. Just a couple of suggestions before I'm ready to merge
| title: Advanced Concepts | ||
| --- | ||
|
|
||
| ## Cleaning final state |
There was a problem hiding this comment.
I think I'd move this under the Operations and State section
|
|
||
| ## Referencing credential secrets in your job code | ||
|
|
||
| :::danger This is NOT a recommended practice |
There was a problem hiding this comment.
I don't think this is as bad as you're saying here - but if you're not comfortable with it I'd drop it from the docs entirely.
It's not really an antipattern, but it's something that users shouldn't need to do. So let's cut it.
| @@ -0,0 +1,181 @@ | |||
| --- | |||
| sidebar_label: Advanced Concepts | |||
| title: Advanced Concepts | |||
There was a problem hiding this comment.
Maybe we can call this Best Practice or something? "advanced" feels very vague
Or maybe we can just move each section somewhere better
| whole batch, and you know which items succeeded and which failed. You can then | ||
| throw an exception to recognise that the job has failed. | ||
|
|
||
| ## Compilation |
There was a problem hiding this comment.
This could be its own page. I'll think about whether to remove it or develop it further. There are some important things here which need to be documented.
3 participants
Short Description
Improve job writing guide docs by grouping into smaller topics and add warning message on
Referencing credentials in job codesection. [See advanced concept page]Closes #714
Details
Referencing credential secretes in job codeAI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy