Skip to content

docs(de-pro): topic-file conventions on 41 older files + stream-static join fix - #40

Merged
kengio merged 5 commits into
mainfrom
docs/de-pro-topic-conventions
Oct 26, 2026
Merged

kengio merged 5 commits into
mainfrom
docs/de-pro-topic-conventions

Conversation

@kengio

@kengio kengio commented Oct 26, 2026

Copy link
Copy Markdown
Owner

Summary

Follow-up to #35: brings the older Data Engineer Professional topic files up to the repo's topic-file conventions (CLAUDE.md), and fixes a factual contradiction found along the way.

Changes

  • Preamble callouts on 41 topic files. Added > [!abstract] and > [!tip] What the Exam Tests. Exam bullets quote the Oct 9, 2026 exam-guide skills from each section README's coverage table.

  • Terminal-section order in 14 files. Variant headings renamed to the standard names. Missing sections (Use Cases, Common Issues, Exam Tips, Related Topics, Official Documentation) were written only from what each file already teaches.

  • Two files split with the part1/part2 rules, because the new sections pushed them past ~800 lines:

    • 05-streaming-joins-stateful: 839 lines → 529 + 343
    • 10-workspace-and-notebooks: 810 lines → 323 + 520

    Section README tables, navigation lines, and inbound links in 6 files are updated, including shared/fundamentals/streaming-fundamentals.md.

  • Factual fix: stream-static joins. 04-structured-streaming-part2.md and 03-incremental-processing.md claimed the static side is read once at query start and needs a restart to pick up changes. Per the docs, each micro-batch joins against the latest valid version of the static Delta table. Both files now say so, matching the streaming-joins file and practice question 5.

  • Link fix: a reintroduced structured-streaming/dedup.html link (404) now points to the watermarks page.

Verification

  • markdownlint: 0 errors on all modified and new files
  • 0 broken relative links repo-wide
  • python3 practice/build.py --cert data-engineer-professional: 0 warnings. The JSON is unchanged.
  • Line-by-line check against the previous version: no content lost. The only differences are renamed headings, rewritten links, and replaced "Next" sections.

🤖 Generated with Claude Code

…to 41 topic files

Tip bullets quote the matching Oct 9, 2026 exam guide skills from each topic README's Exam Skill Coverage table; files without an Overview heading get one above their existing intro.
…tions

Reorder to Use Cases, Common Issues & Errors, Best Practices, Exam Tips, Key Takeaways, Related Topics, Official Documentation; rename variant headings; move Practice Questions and stray content sections ahead of the terminal block. New Exam Tips, Use Cases, and Common Issues restate content already in each file; new Official Documentation links reuse URLs already cited in the repo.
…to part1/part2

05-streaming-joins-stateful (839 lines after the convention fixes) and 10-workspace-and-notebooks (810) exceeded the ~800-line limit. Each part has its own frontmatter, Overview, and preamble callouts; terminal sections live in Part 2. Updates the section README tables, neighbor navigation, and every inbound link.
@kengio
kengio merged commit 81dda1f into main Oct 26, 2026
2 checks passed
@kengio
kengio deleted the docs/de-pro-topic-conventions branch October 26, 2026 15:25
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.

1 participant