Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added comprehensive introduction user manual #273

Merged
merged 3 commits into from
Sep 22, 2023
Merged

Added comprehensive introduction user manual #273

merged 3 commits into from
Sep 22, 2023

Conversation

dmoore247
Copy link
Contributor

Adding introduction to set expectations on what this tooling does.

Add an orienting introduction as to what to expect
Add a comprehensive Introduction
Copy link
Collaborator

@nfx nfx left a comment

Choose a reason for hiding this comment

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

This is the missing user guide!

## Introduction
UCX will guide you, the Databricks customer through the process of upgrading your account, groups, workspaces, jobs etc to Unity Catalog.

The upgrade process starts with installing code to run the upgrade assessment as well as modules for upgrading various components of the system. Component upgrades typically involve evolving configuration and metadata contained within your Databricks deployment. There are parts of the upgrade process that will recommend individual code changes for jobs. The upgrade user will be directed to trigger these operations one by one.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you maybe highlight that normal process is as simple as triggering the jobs created by this app?

@nfx nfx changed the title Add comprehensive introduction Added comprehensive introduction user manual Sep 22, 2023
@nfx nfx added this pull request to the merge queue Sep 22, 2023
Merged via the queue into databrickslabs:main with commit fa5bbbf Sep 22, 2023
2 checks passed
FastLee pushed a commit that referenced this pull request Sep 22, 2023
Adding introduction to set expectations on what this tooling does.
larsgeorge-db pushed a commit that referenced this pull request Sep 23, 2023
Adding introduction to set expectations on what this tooling does.
nfx added a commit that referenced this pull request Sep 29, 2023
# Version changelog

## 0.2.0

* Added retrieving for all account-level groups with matching names to workspace-level groups in case no explicit configuration ([#277](#277)).
* Added crawler for Azure Service principals used for direct storage access ([#305](#305)).
* Added more SQL queries to the assessment step dashboard ([#269](#269)).
* Added filtering out for job clusters in the clusters crawler ([#298](#298)).
* Added recording errors from `crawl_tables` step in `$inventory.table_failures` table and display counter on the dashboard ([#300](#300)).
* Added comprehensive introduction user manual ([#273](#273)).
* Added interactive tutorial for local group migration readme ([#291](#291)).
* Added tutorial links to the landing page of documentation ([#290](#290)).
* Added (internal) support for account-level configuration and multi-cloud workspace list ([#264](#264)).
* Improved order of tasks in the README notebook ([#286](#286)).
* Improved installation script to run in a Windows Git Bash terminal ([#282](#282)).
* Improved installation script by setting log level to uppercase by default ([#271](#271)).
* Improved installation finish messages within installer script ([#267](#267)).
* Improved automation for `MANAGED` table migration and continued building tables migration component ([#295](#295)).
* Fixed debug notebook code with refactored package structure ([#250](#250)) ([#265](#265)).
* Fixed replacement of custom configured database to replicate in the report for external locations ([#296](#296)).
* Removed redundant `notebooks` top-level folder ([#263](#263)).
* Split checking for test failures and linting errors into independent GitHub Actions checks ([#287](#287)).
* Verify query metadata for assessment dashboards during unit tests ([#294](#294)).
@nfx nfx mentioned this pull request Sep 29, 2023
nfx added a commit that referenced this pull request Sep 29, 2023
# Version changelog

## 0.2.0

* Added retrieving for all account-level groups with matching names to
workspace-level groups in case no explicit configuration
([#277](#277)).
* Added crawler for Azure Service principals used for direct storage
access ([#305](#305)).
* Added more SQL queries to the assessment step dashboard
([#269](#269)).
* Added filtering out for job clusters in the clusters crawler
([#298](#298)).
* Added recording errors from `crawl_tables` step in
`$inventory.table_failures` table and display counter on the dashboard
([#300](#300)).
* Added comprehensive introduction user manual
([#273](#273)).
* Added interactive tutorial for local group migration readme
([#291](#291)).
* Added tutorial links to the landing page of documentation
([#290](#290)).
* Added (internal) support for account-level configuration and
multi-cloud workspace list
([#264](#264)).
* Improved order of tasks in the README notebook
([#286](#286)).
* Improved installation script to run in a Windows Git Bash terminal
([#282](#282)).
* Improved installation script by setting log level to uppercase by
default ([#271](#271)).
* Improved installation finish messages within installer script
([#267](#267)).
* Improved automation for `MANAGED` table migration and continued
building tables migration component
([#295](#295)).
* Fixed debug notebook code with refactored package structure
([#250](#250))
([#265](#265)).
* Fixed replacement of custom configured database to replicate in the
report for external locations
([#296](#296)).
* Removed redundant `notebooks` top-level folder
([#263](#263)).
* Split checking for test failures and linting errors into independent
GitHub Actions checks
([#287](#287)).
* Verify query metadata for assessment dashboards during unit tests
([#294](#294)).
FastLee pushed a commit that referenced this pull request Sep 29, 2023
# Version changelog

## 0.2.0

* Added retrieving for all account-level groups with matching names to
workspace-level groups in case no explicit configuration
([#277](#277)).
* Added crawler for Azure Service principals used for direct storage
access ([#305](#305)).
* Added more SQL queries to the assessment step dashboard
([#269](#269)).
* Added filtering out for job clusters in the clusters crawler
([#298](#298)).
* Added recording errors from `crawl_tables` step in
`$inventory.table_failures` table and display counter on the dashboard
([#300](#300)).
* Added comprehensive introduction user manual
([#273](#273)).
* Added interactive tutorial for local group migration readme
([#291](#291)).
* Added tutorial links to the landing page of documentation
([#290](#290)).
* Added (internal) support for account-level configuration and
multi-cloud workspace list
([#264](#264)).
* Improved order of tasks in the README notebook
([#286](#286)).
* Improved installation script to run in a Windows Git Bash terminal
([#282](#282)).
* Improved installation script by setting log level to uppercase by
default ([#271](#271)).
* Improved installation finish messages within installer script
([#267](#267)).
* Improved automation for `MANAGED` table migration and continued
building tables migration component
([#295](#295)).
* Fixed debug notebook code with refactored package structure
([#250](#250))
([#265](#265)).
* Fixed replacement of custom configured database to replicate in the
report for external locations
([#296](#296)).
* Removed redundant `notebooks` top-level folder
([#263](#263)).
* Split checking for test failures and linting errors into independent
GitHub Actions checks
([#287](#287)).
* Verify query metadata for assessment dashboards during unit tests
([#294](#294)).
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.

2 participants