Skip to content

docs: address tutorial review feedback (quickstart, personas, E2E story)#2

Merged
HPicatto merged 1 commit into
HPicatto:feat/dagster-slurm-topic-modeling-examplefrom
geoHeil:fix/tutorial-review-feedback
Jul 18, 2026
Merged

docs: address tutorial review feedback (quickstart, personas, E2E story)#2
HPicatto merged 1 commit into
HPicatto:feat/dagster-slurm-topic-modeling-examplefrom
geoHeil:fix/tutorial-review-feedback

Conversation

@geoHeil

@geoHeil geoHeil commented Jul 18, 2026

Copy link
Copy Markdown

Resolves the tutorial review feedback on #1 (see the review comment). Text-only; no images or links touched.

Mapping to the review points:

  1. Quickstart buried → 3-line git clone && pixi run start block now sits in the intro, with a pointer to Running it for the docker/HPC modes.
  2. Beginner promise implicit → new intro paragraph contrasting the manual login-node/module load/scattered-logs workflow with the version-locked, auto-packed, button-in-the-UI one, including the close-your-laptop/reattach behavior.
  3. Local mode partial coverage → local mode section now names the three assets that materialize locally and carries a {note} admonition stating the three that fail at import time and why.
  4. Expectations → corpus download stated as ~8 MB (verified: the archive is 8.2 MB); first staging run dominated by env packing, warm-cache full chain in minutes.
  5. Queue-wait / sessions → fan-out section now names the fifteen-queue-waits trade-off and points to run-scoped Slurm allocations (Choose an execution mode).
  6. Multi-cluster → real-HPC section now states that separate deployments/code locations can target more than one cluster, linking the Leonardo and VSC-5 guides.
  7. E2E story stops at Slurm → new HPC in the middle, Dagster end to end subsection: everything is sbatch here by choice; before/after stages can be ordinary local assets in the same lineage graph; compute nodes often lack internet, so a download stage would move off-cluster in production.
  8. Iteration loop → folded into the new intro paragraph (identical code, seconds-scale local iteration — for you or your coding agent — promoted unchanged to the cluster).
  9. topic_map screenshot promised but absent → sentence softened to "(not shown above — materialize the group and open topic_map to see it)".

Validation: notebook JSON round-trips (6 cells, no formatting churn — 4 lines changed), codespell clean, all newly added links return 200.

🤖 Generated with Claude Code

- add a quickstart and an explicit 'by hand vs. here' contrast up front
- call out the local iteration loop (identical code, laptop to cluster)
- state which assets run in local mode plus expected size/runtime
- mention run-scoped Slurm allocations for the queue-wait case
- mention multi-cluster targeting via SLURM_EDGE_NODE_* configuration
- add an 'HPC in the middle, Dagster end to end' section
- soften the topic_map claim (plot not among the screenshots)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@HPicatto
HPicatto merged commit 281c924 into HPicatto:feat/dagster-slurm-topic-modeling-example Jul 18, 2026
HPicatto added a commit that referenced this pull request Jul 19, 2026
docs: address tutorial review feedback (quickstart, personas, E2E story)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants