Skip to content

docs(transformations): add OneLake external data sources guide#2716

Draft
Khyat-Cognite wants to merge 1 commit into
feat/onelake-edc-apifrom
feat/onelake-edc-docs
Draft

docs(transformations): add OneLake external data sources guide#2716
Khyat-Cognite wants to merge 1 commit into
feat/onelake-edc-apifrom
feat/onelake-edc-docs

Conversation

@Khyat-Cognite

@Khyat-Cognite Khyat-Cognite commented Jul 9, 2026

Copy link
Copy Markdown

Summary

Slice 3 of 3 — splits PR #2713.

Documentation only. Depends on PR #2714 (data classes) and PR #2715 (client API) being merged first so autosummary targets exist.

What's in this PR (~150 lines)

  • docs/source/transformations_external_data.rst — quickstart: register OneLake source, verify usability, run transform with ext_onelake(), list/delete
  • docs/source/transformations.rst — toctree link to the dedicated page (no duplicate automodule for external_data, avoiding Sphinx duplicate-object warnings)

What came before

PR Scope
1 — Data model (#2714) ExternalDataSource*, OneLake*, IAM capability, data-class unit tests
2 — Client API (#2715) client.transformations.external_data_sources, sync codegen, API + integration tests

What comes next

Nothing — this completes the feature. After all three PRs merge to master, close the monolithic PR #2713.

Test plan

  • build_docs CI green (linkcheck + no duplicate-object warnings)

Parent

Replaces the docs portion of #2713.

@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.66%. Comparing base (cbe7e16) to head (812236a).

Additional details and impacted files
@@                   Coverage Diff                    @@
##           feat/onelake-edc-api    #2716      +/-   ##
========================================================
- Coverage                 93.68%   93.66%   -0.02%     
========================================================
  Files                       510      510              
  Lines                     51578    51578              
========================================================
- Hits                      48322    48312      -10     
- Misses                     3256     3266      +10     

see 5 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-api branch from 746eaa8 to 8a93be4 Compare July 9, 2026 08:53
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from 1dc89bb to 3909d47 Compare July 9, 2026 08:53
@Khyat-Cognite
Khyat-Cognite requested a review from a team July 9, 2026 08:59
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from 3909d47 to 64ca7bc Compare July 9, 2026 09:44
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-api branch 2 times, most recently from 180cf64 to caaafc9 Compare July 9, 2026 10:36
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from 64ca7bc to 73c8907 Compare July 9, 2026 10:36
@Khyat-Cognite Khyat-Cognite self-assigned this Jul 9, 2026
Khyat-Cognite added a commit that referenced this pull request Jul 14, 2026
Remove transformations.rst and index.rst changes from the API slice;
documentation belongs on feat/onelake-edc-docs (#2716).

Co-authored-by: Cursor <cursoragent@cursor.com>
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from e511b13 to f437a6a Compare July 15, 2026 08:44
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-api branch from b08876a to c795c9a Compare July 15, 2026 08:44
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from f437a6a to 6dd1909 Compare July 15, 2026 11:13
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-api branch from c795c9a to c16e088 Compare July 15, 2026 11:13
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from 6dd1909 to b50150e Compare July 15, 2026 11:33
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-api branch from c16e088 to 73fa704 Compare July 15, 2026 11:33
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from b50150e to 1ffc495 Compare July 15, 2026 14:54
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-api branch from fc22e73 to cbe7e16 Compare July 16, 2026 09:41
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from 1ffc495 to 812236a Compare July 16, 2026 09:41
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-api branch from cbe7e16 to d564e77 Compare July 16, 2026 10:12
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from 812236a to 0b6afb9 Compare July 16, 2026 10:12
Add dedicated documentation page with quickstart examples, credential
re-upsert via as_write(client_secret=...), and link from the
transformations index. Uses OneLakeExternalDataSourceWrite constructor.
@Khyat-Cognite
Khyat-Cognite force-pushed the feat/onelake-edc-docs branch from 0b6afb9 to 8766864 Compare July 16, 2026 10:26
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