Skip to content

Commit

Permalink
Update new docs CONTRIBUTING: Current <ReferenceTable> replacement is…
Browse files Browse the repository at this point in the history
… a markdown table (#26542)

## Summary & Motivation

Looks like people have been using Markdown tables in new docs to replace
`<ReferenceTable>` elements in old docs, so I think that's the
recommendation we should go with for now.

## How I Tested These Changes

## Changelog

> Insert changelog entry or delete this section.

Signed-off-by: nikki everett <[email protected]>
  • Loading branch information
neverett authored Dec 17, 2024
1 parent 3c9b9ac commit a748be6
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/docs-beta/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,20 +80,27 @@ Before:

```
<ReferenceTable>
<ReferenceTableItem propertyName="container_context.ecs.env_vars">
A list of keys or key-value pairs to include in the task. If a value is not
specified, the value will be pulled from the agent task.
<br />
In the example above, <code>FOO_ENV_VAR</code> will be set to{" "}
<code>foo_value</code> and <code>BAR_ENV_VAR</code> will be set to whatever
value it has in the agent task.
<ReferenceTableItem propertyName="DAGSTER_CLOUD_DEPLOYMENT_NAME">
The name of the Dagster+ deployment. For example, <code>prod</code>.
</ReferenceTableItem>
<ReferenceTableItem propertyName="DAGSTER_CLOUD_IS_BRANCH_DEPLOYMENT">
If <code>1</code>, the deployment is a{" "}
<a href="/dagster-plus/managing-deployments/branch-deployments">
branch deployment
</a>
. Refer to the <a href="#reserved-branch-deployment-variables">
Branch Deployment variables section
</a> for a list of variables available in branch deployments.
</ReferenceTableItem>
</ReferenceTable>
```

After:

_There is not a replacement at this point in time..._
| Key | Value |
|---|---|
| `DAGSTER_CLOUD_DEPLOYMENT_NAME` | The name of the Dagster+ deployment. <br/><br/> **Example:** `prod`. |
| `DAGSTER_CLOUD_IS_BRANCH_DEPLOYMENT` | `1` if the deployment is a [branch deployment](/dagster-plus/features/ci-cd/branch-deployments/index.md). |

### Whitespace via `{" "}`

Expand Down

1 comment on commit a748be6

@github-actions
Copy link

@github-actions github-actions bot commented on a748be6 Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for dagster-docs-beta ready!

✅ Preview
https://dagster-docs-beta-qt3jfco9l-elementl.vercel.app

Built with commit a748be6.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.