Skip to content

Conversation

@adam-christian-software
Copy link
Contributor

@adam-christian-software adam-christian-software commented Dec 1, 2025

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

  • [N/A] 🛡️ Don't disclose security issues! (contact [email protected])
  • [N/A] 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
  • [N/A] 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
  • [N/A] 💡 Added comments for complex logic
  • [N/A] 🧾 Updated CHANGELOG.md (if needed)
  • 📚 Updated documentation in site/content/in-dev/unreleased (if needed)

Docs Pictures

image image image image

Copy link
Contributor

@dimas-b dimas-b left a 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.

@adam-christian-software adam-christian-software changed the title docs(tools): Create the Projects Section in the Docs docs(tools): Create the Tools Section in the Docs Dec 1, 2025
@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Dec 1, 2025
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.
Copy link
Member

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.

Copy link
Member

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.

Copy link
Contributor Author

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?

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.

3 participants