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

✨ introduce docs #3458

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

renardeinside
Copy link
Contributor

@renardeinside renardeinside commented Dec 20, 2024

New docs incoming!

Tech:

  • Docusaurus
  • TailwindCSS

For details on authoring the docs, please check:
docs/ucx/docs/dev/docs_authoring.mdx

For docs deployment pipeline please check:

.github/workflows/docs-release.yml

This PR doesn't change most of the content, rather just forms it into 4 categories:

  • Installation
  • Process
  • Reference (includes commands, codes, etc.)

Feature wise:

  • 100% Docusaurus and MDX
  • Auto-link checking, checks both links and anchors!
  • Cool landing page
  • Clickable images

To setup the env and run/edit docs locally, please use instructions in docs/ucx/docs/dev/docs_authoring.mdx.

Target URL for docs after deployment is https://databrickslabs.github.io/ucx/

Some screenshots:
image
image

@renardeinside renardeinside marked this pull request as ready for review January 16, 2025 22:45
@renardeinside renardeinside requested a review from a team as a code owner January 16, 2025 22:45
Copy link
Member

@JCZuurmond JCZuurmond left a comment

Choose a reason for hiding this comment

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

@renardeinside : Thanks for opening this.

The structure looks like a good start and I think further reviewing for specific pages should be done in separate PRs. I would like to keep this PR about moving to the new documentation only.

If the release CI works and @gueniai approves, this PR is good to go!

README.md Outdated Show resolved Hide resolved
docs/ucx/docs/installation/index.mdx Show resolved Hide resolved
docs/ucx/docs/installation/index.mdx Outdated Show resolved Hide resolved
Co-authored-by: Cor <jczuurmond@protonmail.com>
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