-
Notifications
You must be signed in to change notification settings - Fork 332
docs(tools): Create the Projects Section in the Docs #3033
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
docs(tools): Create the Projects Section in the Docs #3033
Conversation
snazy
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 looks like a very good start to give the Polaris tools more awareness.
I'd just prefer to have the new tools/ folder directly under site/content, because the tools are not tied to Polaris releases, but have their own release cadence, if at all.
The Polaris tools could be added to the Documentation menu.
If you replace this line with this line
<li>{{ .Pre }}<a class="dropdown-item" href="{{ .URL }}">{{ .Name }}</a> {{ .Post }}</li>
you can also add pre: "html code" and post: "html code" as described here.
site/content/in-dev/unreleased/getting-started/creating-a-catalog/catalog-migration.md
Outdated
Show resolved
Hide resolved
@snazy - You are completely right about the new section! I need to think a bit more about this because, from my understanding, we are trying to have each tool to be release independently. So, while having a top-level item for tools makes sense right now, it might not support us longer-term when we have Iceberg Catalog Migrator launching at a different cadence from the MCP Server. Let me think about this and get back to you. |
|
Not sure whether we have to solve that problem now. For example the iceberg-catalog-migrator: it's rather a tool that is used once. I suspect nobody really cares about docs of old versions of that tool. |
flyrain
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.
Thanks for the change, @adam-christian-software ! LGTM.
Context
This is a docs change which provides a Projects 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