Skip to content

Commit f240855

Browse files
pritishpaipritishpai
authored
Enhance documentation for UCX (#4024)
## Changes New and improved UCX documentation with an enhanced main page and other fixes where required ### Functionality - [x] modified relevant user documentation ### Tests - [x] manually tested - [x] verified on local environment (screenshot attached)
1 parent 8d0e018 commit f240855

File tree

6 files changed

+102
-34
lines changed

6 files changed

+102
-34
lines changed

‎docs/ucx/docs/dev/index.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 5
33
---
44

55
# Contributing to UCX
66

7-
This section is for contributors to the UCX toolkit. It contains information on how to contribute to the toolkit, including how to submit issues, pull requests, and how to contribute to the documentation.
7+
This section is for contributors to the UCX. It contains information on how to contribute to the project, including how to submit issues, pull requests, and how to contribute to the documentation.
8+
## How to Contribute
9+
10+
- [Developer Guide](/docs/dev/contributing)
11+
- [Authoring Documentation](/docs/dev/docs_authoring)

‎docs/ucx/docs/gettingstarted/index.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Getting Started
6+
7+
Welcome to UCX — Unity Catalog Toolkit. UCX is developed and maintained by Databricks Labs with the purpose of streamlining Unity Catalog migrations and enhance Unity Catalog capabilities.
8+
9+
Follow the steps below to successfully install, run, and operate UCX.
10+
11+
---
12+
13+
## 📖 Table of Contents
14+
15+
1. [Installation](/docs/installation):
16+
Set up UCX and configure your environment for Unity Catalog migration.
17+
18+
2. [Running UCX](/docs/process):
19+
Learn how to start UCX and perform assessment or migration tasks.
20+
21+
3. [Reference](/docs/reference):
22+
Explore the reference of UCX.
23+
24+
---
25+
26+
Not sure where to begin? Start with the [Installation Guide](/docs/installation).

‎docs/ucx/docs/installation/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 2
33
---
44
# Installation
55

6-
UCX installation is covered by this section.
6+
This section guides you through the steps required to install UCX, configure necessary tools, and ensure your environment is ready for a seamless Unity Catalog migration.
77

88
## Installation requirements
99

‎docs/ucx/docs/process/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 3
33
---
44

5-
# Process
5+
# Running UCX
66

77
On a high level, the steps in migration process are:
88
1. [assessment](/docs/reference/workflows#assessment-workflow)

‎docs/ucx/docs/reference/index.mdx

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 4
33
---
44

55
# Reference
66

7-
This section contains the reference documentation for the UCX toolkit.
7+
This section contains the reference documentation for the UCX toolkit.
8+
9+
It includes the following:
10+
- [Commands](/docs/reference/commands)
11+
- [Migration Assessment Report](/docs/reference/assessment)
12+
- [Common Challenges](/docs/reference/common_challenges)
13+
- [Dashboards](/docs/reference/dashboards)
14+
- [External Hive Metastore Integration](/docs/reference/external_hms_glue)
15+
- [Group Name Conflict Resolution](/docs/reference/group_name_conflict)
16+
- [Linter Message Codes](/docs/reference/linter_codes)
17+
- [Workspace Group Migration](/docs/reference/local-group-migration)
18+
- [Migration Progress](/docs/reference/migration-progress)
19+
- [Inventory](/docs/reference/table_persistence)
20+
- [Table Upgrade](/docs/reference/table_upgrade)
21+
- [Troubleshooting Guide](/docs/reference/troubleshooting)
22+
- [Workflows](/docs/reference/workflows)

‎docs/ucx/src/pages/index.tsx

Lines changed: 49 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,63 @@
1+
import React from 'react';
12
import Layout from '@theme/Layout';
2-
import Button from '../components/Button';
3-
import { JSX } from 'react';
3+
import Link from '@docusaurus/Link';
44

5-
6-
7-
const Hero = () => {
5+
export default function Home(): JSX.Element {
86
return (
9-
<div className='flex flex-col items-center h-screen pt-20 w-full'>
10-
<div className="px-4 md:px-10 max-w-screen-xl h-[calc(100vh-140px)] flex flex-col md:flex-row justify-between w-full">
11-
{/* <!-- Left Column (Text) --> */}
7+
<Layout
8+
title="UCX - Unity Catalog Toolkit"
9+
description="UCX helps assess, plan, and execute your Databricks Unity Catalog migration efficiently."
10+
>
11+
<main className="flex flex-col md:flex-row items-center justify-center px-6 md:px-12 py-12">
1212
<div className="md:w-2/3 text-center md:text-left">
13-
<h1 className="text-5xl font-semibold leading-tight text-balance mb-6"><span className='font-mono'>UCX</span> - Unity Catalog
14-
Migration Assistant</h1>
15-
<p className="text-xl mb-6 text-balance">
16-
Ready-to-use toolkit to migrate to UC,<br /> provided by <a href="https://github.com/databrickslabs" className="underline">Databricks Labs</a>
13+
<h1 className="text-4xl font-bold mb-6">
14+
Simplify and Accelerate your Unity Catalog Migration
15+
</h1>
16+
<p className="text-lg mb-8">
17+
The open-source tool that helps assess, plan, and execute your Databricks Unity Catalog migration with confidence.
1718
</p>
18-
<div className="flex flex-col space-y-4 md:flex-row md:space-y-0 md:space-x-4 md:justify-start justify-center items-center w-full px-20 md:px-0">
19-
<Button variant='secondary' outline={true} link='/docs/installation' size='large' label='Installation' linkClassName='w-full md:w-fit' className='w-full' />
20-
<Button variant='secondary' outline={true} link='/docs/process' size='large' label='Process' linkClassName='w-full md:w-fit' className='w-full' />
21-
<Button variant='secondary' outline={true} link='/docs/reference' size='large' label='Reference' linkClassName='w-full md:w-fit' className='w-full' />
19+
<div className="flex justify-center md:justify-start space-x-4">
20+
<Link
21+
className="px-6 py-3 text-white bg-red-600 rounded-md hover:bg-red-700 hover:text-white transition-colors duration-200"
22+
to="/docs/gettingstarted"
23+
>
24+
Get Started
25+
</Link>
2226
</div>
2327
</div>
2428

25-
{/* <!-- Right Column (Image) --> */}
2629
<div className="hidden md:block md:w-1/3 mt-10 md:mt-0">
27-
<img src="img/logo.svg" alt="UCX Logo" className="w-full rounded-lg hidden md:block" />
30+
<img
31+
src="img/logo.svg"
32+
alt="UCX Logo"
33+
className="w-2/3 mx-auto md:w-full md:max-w-xs"
34+
/>
35+
</div>
36+
</main>
37+
38+
<section className="px-6 md:px-12 py-12 text-center bg-gray-50 dark:bg-gray-900 text-gray-900 dark:text-gray-100">
39+
<h2 className="text-3xl font-semibold mb-8">Key Features</h2>
40+
<div className="flex flex-col md:flex-row justify-center space-y-8 md:space-y-0 md:space-x-12">
41+
<div>
42+
<h3 className="text-xl font-bold mb-2">🔍 Comprehensive Assessment</h3>
43+
<p>Identify migration blockers and readiness with detailed analysis.</p>
44+
</div>
45+
<div>
46+
<h3 className="text-xl font-bold mb-2">🚀 Automated Migrations</h3>
47+
<p>Simplify moving data assets and permissions efficiently.</p>
48+
</div>
49+
<div>
50+
<h3 className="text-xl font-bold mb-2">📊 Detailed Reporting</h3>
51+
<p>Gain actionable insights into your migration progress.</p>
2852
</div>
2953
</div>
30-
</div>
31-
)
32-
}
54+
</section>
3355

34-
export default function Home(): JSX.Element {
35-
return (
36-
<Layout>
37-
<Hero />
38-
</Layout >
56+
57+
<footer className="text-center py-6 border-t mt-12 text-gray-600 text-sm">
58+
<a href="https://github.com/databrickslabs/ucx" target="_blank" rel="noopener" className="mx-2 hover:underline">GitHub</a>|
59+
<Link to="docs/dev" className="mx-2 hover:underline">Contribute</Link>
60+
</footer>
61+
</Layout>
3962
);
4063
}

0 commit comments

Comments
 (0)