[docs] fix docs snippet and markdown content#33591
Open
jjyeo wants to merge 1 commit into
Open
Conversation
Contributor
Greptile SummaryThis PR makes several targeted documentation fixes across the Dagster OSS docs: adds the missing
Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| examples/docs_snippets/docs_snippets/deploying/dagster_instance/dagster.yaml | Adds a backfills YAML snippet between start_marker_backfills/end_marker_backfills markers, which are already referenced by the <CodeExample> in oss-instance-configuration.md. The use_threads and num_workers keys are confirmed correct per the Dagster source (backfills_daemon_config()). Consistent pattern with existing sensors and schedules snippets. |
| docs/docs/deployment/oss/oss-deployment-architecture.md | Fixes a broken Markdown table for "Job execution flow" — adds a proper numeric Order column (1–4) and correctly distributes component links, descriptions, and config-level values across the right columns. |
| docs/docs/deployment/oss/deployment-options/docker.md | Fixes collapsed prerequisites in the <details> block — separates the previously concatenated list items onto their own lines for correct Markdown rendering. |
| docs/docs/guides/build/projects/workspaces/workspace-yaml.md | Removes the duplicate "Location of workspace.yaml" section; the same content (including the -w flag usage) is already fully covered in the "Loading workspace files" section below. |
| docs/docs/dagster-basics-tutorial/6-custom-components.md | Fixes a double-word typo: "from a a YAML" → "from a YAML". |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["dagster.yaml snippet file\n(docs_snippets/deploying/dagster_instance/dagster.yaml)"]
A -->|start_marker_backfills / end_marker_backfills| B["oss-instance-configuration.md\n(Backfill processing section)"]
A -->|start_marker_schedules / end_marker_schedules| C["oss-instance-configuration.md\n(Schedule processing section)"]
A -->|start_marker_sensors / end_marker_sensors| D["oss-instance-configuration.md\n(Sensor processing section)"]
B --> E["Rendered Docs Page:\nBackfill Processing Config Example"]
subgraph "Other Docs Fixes (this PR)"
F["oss-deployment-architecture.md\nFixed Job Execution Flow table"]
G["docker.md\nFixed Prerequisites formatting"]
H["workspace-yaml.md\nRemoved duplicate section"]
I["6-custom-components.md\nFixed double-word typo"]
end
Last reviewed commit: 9edbbd5
Collaborator
|
@jjyeo There have been some changes to master since you opened this, can you rebase? Thanks! |
- Add code snippet for backfill config in `dagster.yaml` - Remove redundant section in `workspace-yaml.md` - Fix markdown table
9edbbd5 to
30b279a
Compare
Contributor
Author
|
@neverett Changes applied. Could you please review it? Thank you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary & Motivation
Add a code snippet for Backfill processing configuration in

dagster.yaml.Remove Location of workspace.yaml section from
workspace-yaml.mdas it duplicates the Loading workspace files section.Fix Markdown table under Job execution flow.

Test Plan
Local build and test