Update 'Configure settings and profiles' documentation to include prefect.toml support
#15847
Conversation
desertaxle
requested review from
discdiver,
cicdw and
zzstoatzz
as code owners
desertaxle
changed the title
prefect.toml supportprefect.toml support
|
|
||
| ## Settings sources | ||
|
|
||
| You can configure settings via the following sources: |
There was a problem hiding this comment.
I think it would be useful if you explicitly state here that these will be listed in order of precedence, or reverse order of precedence in this case. (And keep the list below too, I just think the redundancy is useful in this case)
There was a problem hiding this comment.
Makes sense! I added an aside that this list is from highest precedence to lowest.
There was a problem hiding this comment.
Makes sense! I added an aside that this list is from highest precedence to lowest.
|
|
||
| You can configure settings via the following sources: | ||
|
|
||
| - **Environment Variables**: Environment variables are useful for temporarily overriding settings or configuring the runtime environment of a workflow. |
There was a problem hiding this comment.
| - **Environment Variables**: Environment variables are useful for temporarily overriding settings or configuring the runtime environment of a workflow. | |
| - **Environment Variables**: Environment variables are useful for temporarily overriding settings or configuring the runtime environment of a workflow or an individual execution of a workflow. |
something to emphasize that env vars are the most dynamically configurable?
There was a problem hiding this comment.
Updated the wording in ada17ce
I think that's mostly down to personal preference. I can include a link to some TOML documentation for users who want to learn more. Do you think that would help? |
yes! saying its arbitrary / up to yaml in general would be helpful imo |
|
@zzstoatzz how does this look? |
desertaxle
force-pushed
the
update-manage-settings-doc
branch
from
333cb37 to
a8061c8
Compare
This PR updates the 'Configure settings and profiles' doc to include
prefect.tomlsupport. I beefed up the intro a little bit to establish what settings enable and how to get started with them. I included a list of supported setting sources and the order they are used to resolve settings values. I also included information about where each setting source is best used.Very open to feedback about the overall structure and recommendation in addition to the specific wording used.
Closes #10697