-
Notifications
You must be signed in to change notification settings - Fork 87
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
base: main
Are you sure you want to change the base?
✨ introduce docs #3458
Conversation
There was a problem hiding this 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!
Co-authored-by: Cor <jczuurmond@protonmail.com>
New docs incoming!
Tech:
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:
Feature wise:
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: