Skip to content

Document the assessment report#806

Merged
nfx merged 10 commits intomainfrom
fix/assessment_docs
Jan 24, 2024
Merged

Document the assessment report#806
nfx merged 10 commits intomainfrom
fix/assessment_docs

Conversation

@dmoore247
Copy link
Copy Markdown
Contributor

@dmoore247 dmoore247 commented Jan 17, 2024

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

  • added relevant user documentation

Tests

  • manually tested (reviewed)
    Circulating draft with field eng and select customers

@dmoore247 dmoore247 self-assigned this Jan 17, 2024
@dmoore247 dmoore247 requested review from a team and dipankarkush-db January 17, 2024 15:53
@dmoore247 dmoore247 added the documentation Improvements or additions to documentation label Jan 17, 2024
@dmoore247 dmoore247 marked this pull request as draft January 17, 2024 15:53
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e36db5f) 85.39% compared to head (75be922) 85.39%.

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.
📢 Have feedback on the report? Share it here.

@@ -0,0 +1,51 @@
# Assessment Report Summary

# Assessment Dashlets
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# 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.
@dmoore247 dmoore247 changed the title Initial outline and content to document the Assessment (main) report Document the Assessment (main) report Jan 20, 2024
@dmoore247 dmoore247 added the enhancement New feature or request label Jan 20, 2024
@dmoore247 dmoore247 marked this pull request as ready for review January 20, 2024 18:20
@dmoore247 dmoore247 enabled auto-merge January 20, 2024 18:20
@dmoore247
Copy link
Copy Markdown
Contributor Author

@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">
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Images are not version controllable, try to avoid them. We're changing to lakeview soon, anyway

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Here's what I'm talking about.

Besides, we're changing the dashboards to lakeview soon

@dmoore247 dmoore247 requested a review from nfx January 23, 2024 14:32
@nfx nfx changed the title Document the Assessment (main) report Document the Assessment report Jan 24, 2024
@nfx nfx changed the title Document the Assessment report Document the assessment report Jan 24, 2024
@nfx nfx merged commit ae54f76 into main Jan 24, 2024
@nfx nfx deleted the fix/assessment_docs branch January 24, 2024 08:58
nfx added a commit that referenced this pull request Jan 26, 2024
* 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)).
@nfx nfx mentioned this pull request Jan 26, 2024
nfx added a commit that referenced this pull request Jan 26, 2024
* 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)).
dmoore247 added a commit that referenced this pull request Mar 23, 2024
dmoore247 pushed a commit that referenced this pull request Mar 23, 2024
* 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)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add assessment finding identifier and reference link for each item found in the assessment

2 participants