Skip to content

Commit f3525cc

Browse files
authored
OSS clean up (#3)
* Delete src/.DS_Store * updated docs link in README * remove unused import * extend get update_id logic to increase chance of retrieval * fix cdc_snapshot file name typo * remove unused sample resource files * add backtick to sink name
1 parent 4601bff commit f3525cc

24 files changed

Lines changed: 24 additions & 41 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Framework is designed for simplicity, performance and alignment to the Datab
1616

1717
## Documentation
1818

19-
Please refer to the [documentation](./docs/_build/html/index.html) for further details and an explanation of the samples.
19+
Please refer to the [documentation](https://databricks-solutions.github.io/lakeflow_framework/) for further details and an explanation of the samples.
2020
The documentation needs to be deployed as HTML or Markdown within your org before it can be used.
2121

2222
## How to get help

docs/source/index.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@
44
contain the root `toctree` directive.
55
66
Lakeflow Framework documentation
7-
===========================
7+
=================================
88

9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
9+
The Lakeflow Framework is a metadata-driven data engineering framework built for Databricks. It accelerates and simplifies the deployment of Spark Declarative Pipelines (SDP) while supporting your entire software development lifecycle.
1210

11+
**Key Capabilities:**
12+
13+
* Build robust data pipelines using a configuration-driven, Lego-block approach
14+
* Support batch and streaming workloads across the medallion architecture (Bronze, Silver, Gold)
15+
* Deploy seamlessly with Databricks Asset Bundles (DABS)—no wheel files or control tables required
16+
* Extend and maintain easily as your data platform evolves
17+
18+
This documentation covers everything from getting started to advanced orchestration patterns. Explore the sections below to begin building reliable, maintainable data pipelines.
1319

1420
.. toctree::
1521
:maxdepth: 4

pipeline_bundle_template/resources/<PIPELINE NAME>_pipeline.yml renamed to pipeline_bundle_template/resources/PIPELINE NAME_pipeline.yml

File renamed without changes.

pipeline_bundle_template/src/dataflows/<PIPELINE NAME 1>/dataflowspec/[flow]<TARGET TABLE>_main.json renamed to pipeline_bundle_template/src/dataflows/PIPELINE_NAME_1/dataflowspec/[flow]TARGET TABLE_main.json

File renamed without changes.

pipeline_bundle_template/src/dataflows/<PIPELINE NAME 1>/dataflowspec/[standard]<TARGET TABLE>_main.json renamed to pipeline_bundle_template/src/dataflows/PIPELINE_NAME_1/dataflowspec/[standard]TARGET TABLE_main.json

File renamed without changes.

pipeline_bundle_template/src/dataflows/<PIPELINE NAME 1>/expectations/<TARGET TABLE>_dqe.json renamed to pipeline_bundle_template/src/dataflows/PIPELINE_NAME_1/expectations/TARGET TABLE_dqe.json

File renamed without changes.

pipeline_bundle_template/src/dataflows/<PIPELINE NAME 1>/schemas/<TARGET TABLE>_schema.json renamed to pipeline_bundle_template/src/dataflows/PIPELINE_NAME_1/schemas/TARGET TABLE_schema.json

File renamed without changes.

pipeline_bundle_template/src/dataflows/<PIPELINE NAME 2>/dataflowspec/[flow]<TARGET TABLE>_main.json renamed to pipeline_bundle_template/src/dataflows/PIPELINE_NAME_2/dataflowspec/[flow]TARGET TABLE_main.json

File renamed without changes.

pipeline_bundle_template/src/dataflows/<PIPELINE NAME 2>/dataflowspec/[standard]<TARGET TABLE>_main.json renamed to pipeline_bundle_template/src/dataflows/PIPELINE_NAME_2/dataflowspec/[standard]TARGET TABLE_main.json

File renamed without changes.

pipeline_bundle_template/src/dataflows/<PIPELINE NAME 2>/expectations/<TARGET TABLE>_dqe.json renamed to pipeline_bundle_template/src/dataflows/PIPELINE_NAME_2/expectations/TARGET TABLE_dqe.json

File renamed without changes.

0 commit comments

Comments
 (0)