Add info on link_task_source to docs
#885
Conversation
facebook-github-bot
added
the
CLA Signed
Etesam913
changed the title
link_task_source to docs
mephisto/operations/task_launcher.py
Outdated
| ): | ||
| logger.info( | ||
| "If you want your server to update on reload whenever you make changes to your webapp, then make sure to set \n\nlink_task_source: true\n\nin your task's hydra configuration and run \n\ncd webapp && npm run dev:watch\n\nin a separate terminal window. For more information check out:\nhttps://mephisto.ai/docs/guides/tutorials/custom_react/#12-launching-the-task" | ||
| ) |
There was a problem hiding this comment.
What is the rationale for putting the checking code here as opposed to somewhere else? Not challenging, just curious. Is there any other place this could be placed up the function call stack?
I find that adding a new param to the function just for this functionality to be a bit of a code smell, though I'm willing to be talked out of it.
There was a problem hiding this comment.
It seems to be messing up the python build test so I will probably have to find a new place to put it.
I put it there so that I could get access to the run_config variables. I need to check if link_task is set to false before showing anything.
There was a problem hiding this comment.
e.g. why not put it in launch_task_run_or_die?
There was a problem hiding this comment.
Ditto to @pringshia's concern here. While I'm a big fan of raising visibility on this, I think the best place to put this warning is actually inside of the assert_task_args method for the StaticReactBlueprint. (If the architect is in the allowed architects and link_task_source is false, let people know).
There was a problem hiding this comment.
Yeah, this seems like a way better solution. This will also most likely prevent the tests from failing.
🎨 Added a little bit of color to the logging message
Overview
For local development using the
link_task_sourceproperty can significantly improve productivity. However, on the docs, there is not much information available on it.When searching "link_task_source" on the docs I only get two results, which both come from the blueprint table.
Ideally there should be some info on this property in the tutorial.
Changes:
link_task_sourcelink_task_sourceset to false.Updated documentation section in "working on a custom task" page
Logging message that shows when
link_task_sourceis set to false