[SPARK-54895][SDP][DOCS] Fix markdown issues in Spark Declarative Pipelines Programming Guide #53671
Conversation
JIRA Issue Information=== Improvement SPARK-54895 === This comment was automatically generated by GitHub Actions |
|
@sryza Mind reviewing 🙏 |
|
@sryza Could you review the PR? 🙏 |
| ## What is Spark Declarative Pipelines (SDP)? | ||
|
|
||
| Spark Declarative Pipelines (SDP) is a declarative framework for building reliable, maintainable, and testable data pipelines on Apache Spark. SDP simplifies ETL development by allowing you to focus on the transformations you want to apply to your data, rather than the mechanics of pipeline execution. | ||
| <!-- rumdl-disable MD013 --> |
There was a problem hiding this comment.
Do we follow this convention in other md files? Given that the target for this content is the docs site, and the docs site wraps text, I think in general it would be better to use a ruleset that allows docs authors to write paragraphs than to try to fit inside arbitrary line length boundaries.
There was a problem hiding this comment.
Do we follow this convention in other md files?
Likely no. No idea. We could introduce a precedence that eventually could become a rule across the whole docs (it does not hurt either way, does it?).
More importantly, I didn't mean to change all the pages atm (and acquiring a single person's PoV (i.e., you)). I'd not be surprised if people didn't care about such tiny bits 🤷
| - `saveAsTable()` | ||
| - `start()` | ||
| - `toTable()` | ||
| * `collect()` |
There was a problem hiding this comment.
Are asterixes the convention that's used most widely in other docs pages?
There was a problem hiding this comment.
Not sure, but asterisks seemed recommended (over dashes) by rumdl.
2 participants
What changes were proposed in this pull request?
Fix markdown issues reported by
rumdl check.Fixes https://issues.apache.org/jira/browse/SPARK-54895
Why are the changes needed?
This single markdown page can pave the way towards "better docs". One file at a time.
After the changes, there are no errors reported:
$ rumdl check declarative-pipelines-programming-guide.md Success: No issues found in 1 file (28ms)Does this PR introduce any user-facing change?
No
How was this patch tested?
Local preview in Visual Code.
Was this patch authored or co-authored using generative AI tooling?
No