-
Notifications
You must be signed in to change notification settings - Fork 338
docs(tools): Create the Tools Section in the Docs #3189
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
base: main
Are you sure you want to change the base?
docs(tools): Create the Tools Section in the Docs #3189
Conversation
dimas-b
left a comment
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.
This doc refactoring LGTM in general... just a naming comment below.
| 2. Using the [Polaris Synchronizer tool](https://github.com/apache/polaris-tools/blob/main/polaris-synchronizer/README.md): A tool to migrate entities from one Polaris instance to another. This tool is specific to Polaris. | ||
|
|
||
| Both of these tools are available in the [Polaris-Tools repository](https://github.com/apache/polaris-tools). Please refer to the relevant README.md documentation for more information. | ||
| 1. Using the [Iceberg Catalog Migrator tool](../../../../../tools/iceberg-catalog-migrator/): A command-line tool to migrate Iceberg tables from one Iceberg catalog to another. |
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.
The links in this file will not work, see the URLs shown in a browser. The folder structure does not represent the real URLs.
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.
Try with site/bin/run-hugo-in-docker.sh.
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.
Thanks for the feedback!
I just tried with site/bin/run-hugo-in-docker.sh and it works. Is there a better convention I should use?
Context
This is a docs change which provides a Tools section in the top-level nav in the Docs. It handles this issue #2843 .
Currently, each tool just provides a link to the README in the Polaris-Tools repository. I'll be going through each tool and updating their README in Polaris-Tools and, then, bringing in user-facing docs which will clearly illustrate usage of these tools.
Checklist
CHANGELOG.md(if needed)site/content/in-dev/unreleased(if needed)Docs Pictures