This project is a proof-of-concept to improve the Apache Spark Structured Streaming documentation. It is effectively a re-organization of the Structured Streaming Programming Guide, the document from which it borrows many concepts and shares code snippets. It also tries to add practical advice in relevant places, emphasizing clarity over precision. In no way does this repo claim to be fully original work: this project would be nothing without the years of effort that went into the Apache Spark documentation.
In particular, this project has the following notable features:
cd
into the cloned repository directory.python3 -m venv env
. And then, source ./env/bin/activate
pip install -r requirements.txt
mkdocs serve
. That should give you a local URL on which you can view changes.