reference for built-in env vars #24020
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @jamiedemaria and the rest of your teammates on |
|
Deploy preview for dagster-docs-beta ready! Preview available at https://dagster-docs-beta-owwua2weg-elementl.vercel.app Direct link to changed pages:
|
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-u6gknkgdf-elementl.vercel.app Direct link to changed pages: |
docs/docs-beta/docs/dagster-plus/deployment/environment-variables/built-in.md
Show resolved
Hide resolved
| | Key | Value | | ||
| |---|---| | ||
| | DAGSTER_CLOUD_GIT_SHA | The SHA of the commit. <br/><br/> **Example:** `5c5fa4643968a1b8043b58c159fb0600af8a35b2`. | |
There was a problem hiding this comment.
I'm playing around with the idea of having examples for each of the env vars. I think for some of them it's kind of redundant (like email, pr message, etc). For ones like the timestamp though, I think it is really useful as a reader to know what format you're getting the data in (YYYY-MM-DD vs MM-DD-YYYY, vs a timestamp int, etc)
Does it feel odd to have examples for some but not all? I think the timestamp var is the only one that really needs it...
There was a problem hiding this comment.
Yea I tend to agree. I don't think they all need it. Although for Unix timestamp we should mention if its in seconds or ms, since its not always standardized.
jamiedemaria
force-pushed
the
jamie/doc-408-refresh-dagster-built-in-environment-variables
branch
from
e3581b3 to
751f2c2
Compare
| |---|---| | ||
| | DAGSTER_CLOUD_GIT_SHA | The SHA of the commit. <br/><br/> **Example:** `5c5fa4643968a1b8043b58c159fb0600af8a35b2`. | | ||
| | DAGSTER_CLOUD_GIT_TIMESTAMP | The Unix timestamp when the commit occurred. <br/><br/> **Example:** `1724871941` | |
There was a problem hiding this comment.
annoyingly, on my laptop screen some of the descriptions are too long and they make the table scroll horizontally. Is there a way to make the text overflow onto a new line rather than scroll?
There was a problem hiding this comment.
oh that is annoying. i say leave it for now, we can fix it with better styling
graphite-app
bot
requested review from
PedramNavid,
erinkcochran87 and
cmpadden
Graphite Automations"docs-beta - Assign Reviewers" took an action on this PR • (08/28/24)1 label was added and 3 reviewers were added to this PR based on Pedram Navid's automation. |
jamiedemaria
force-pushed
the
jamie/doc-410-refresh-setting-env-vars-in-the-dagster-ui
branch
from
5395e14 to
8f910be
Compare
jamiedemaria
force-pushed
the
jamie/doc-408-refresh-dagster-built-in-environment-variables
branch
from
751f2c2 to
c6c44e7
Compare
jamiedemaria
force-pushed
the
jamie/doc-408-refresh-dagster-built-in-environment-variables
branch
from
c6c44e7 to
e8840e8
Compare
jamiedemaria
deleted the
jamie/doc-408-refresh-dagster-built-in-environment-variables
branch
Summary & Motivation
Knocking out this pretty easy one too while i do the other env var doc. I have a couple aesthetic questions about how to format some things, but i think the existing doc does a pretty good job, so i ended up re-using most of it
Docs preview - https://dagster-docs-beta-5iiwhw9qp-elementl.vercel.app/dagster-plus/deployment/environment-variables/built-in
How I Tested These Changes
Changelog [New | Bug | Docs]
NOCHANGELOG