Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #806 +/- ##
=======================================
Coverage 85.39% 85.39%
=======================================
Files 40 40
Lines 5031 5031
Branches 921 921
=======================================
Hits 4296 4296
Misses 523 523
Partials 212 212 ☔ View full report in Codecov by Sentry. |
docs/assessment.md
Outdated
| @@ -0,0 +1,51 @@ | |||
| # Assessment Report Summary | |||
|
|
|||
| # Assessment Dashlets | |||
There was a problem hiding this comment.
| # Assessment Dashlets | |
| # Assessment Widgets |
that's how we're calling them. Don't introduce new term
Incorporate dashlet/widget term feedback from @nfx
Document each Dashlet, Row, and Widget for the assessment results.
…ssessment findings
|
@nfx Ready for review and merge. |
| The Assessment Report (Main) is the output of the Databricks Labs UCX assessment workflow. This report queries the $inventory database (e.g. `ucx`) and summarizes the findings of the assessment. The link to the Assessment Report (Main) can be found in your home folder, under `.ucx` in the README.py file. The user may also directly navigate to the Assessment report by clicking on `Dashboards` icon on the left to find the Dashboard. | ||
|
|
||
| # Assessment Dashlets | ||
| <img width="1655" alt="image" src="https://github.com/databrickslabs/ucx/assets/1122251/808f7c68-fcc7-4caa-bab2-03f49a382256"> |
There was a problem hiding this comment.
Images are not version controllable, try to avoid them. We're changing to lakeview soon, anyway
There was a problem hiding this comment.
Please take a look at the doc, the images really pull it together for the reader, breaking the text into bite size bits.
As far as versioning images go, the images are immutable and not intended to be versioned in place, github does a really nice job. When Lakeview comes along it's just 5 copy paste operations.
* Added `databricks labs ucx alias` command to create a view of tables from one schema/catalog in another schema/catalog ([#837](#837)). * Added `databricks labs ucx save-aws-iam-profiles` command to scan instance profiles identify AWS S3 access and save a CSV with permissions ([#817](#817)). * Added total view counts in the assessment dashboard ([#834](#834)). * Cleaned up `assess_jobs` and `assess_clusters` tasks in the `assessment` workflow to improve testing and reduce redundancy.([#825](#825)). * Added documentation for the assessment report ([#806](#806)). * Fixed escaping for SQL object names ([#836](#836)). Dependency updates: * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([#832](#832)).
* Added `databricks labs ucx alias` command to create a view of tables from one schema/catalog in another schema/catalog ([#837](#837)). * Added `databricks labs ucx save-aws-iam-profiles` command to scan instance profiles identify AWS S3 access and save a CSV with permissions ([#817](#817)). * Added total view counts in the assessment dashboard ([#834](#834)). * Cleaned up `assess_jobs` and `assess_clusters` tasks in the `assessment` workflow to improve testing and reduce redundancy.([#825](#825)). * Added documentation for the assessment report ([#806](#806)). * Fixed escaping for SQL object names ([#836](#836)). Dependency updates: * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([#832](#832)).
* Added `databricks labs ucx alias` command to create a view of tables from one schema/catalog in another schema/catalog ([#837](#837)). * Added `databricks labs ucx save-aws-iam-profiles` command to scan instance profiles identify AWS S3 access and save a CSV with permissions ([#817](#817)). * Added total view counts in the assessment dashboard ([#834](#834)). * Cleaned up `assess_jobs` and `assess_clusters` tasks in the `assessment` workflow to improve testing and reduce redundancy.([#825](#825)). * Added documentation for the assessment report ([#806](#806)). * Fixed escaping for SQL object names ([#836](#836)). Dependency updates: * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([#832](#832)).

Changes
Documenting the Assessment (main) report. This is the initial revision of the document to help guide users through interpreting the Assessment report. This document is fairly complete with inline screen shots, document introduction, Assessment Finding Index.
Assessment queries and messages may be numbered and linked in future PRs but not this PR.
Linked issues
Resolves #748
Functionality
Tests
Circulating draft with field eng and select customers