samredai commented on issue #4805: URL: https://github.com/apache/iceberg/issues/4805#issuecomment-1130071654
Hey @pvary , thanks for sharing this! We've landed on a structural theme recently and we're working towards getting all of the docs aligned for a consistent feel of "where to find what" if that makes sense. I've tried to summarize it in the [CONTRIBUTING.md](https://github.com/apache/iceberg-docs/blob/03d738472100f434094def2062527f1fb3f700a4/CONTRIBUTING.md) that's currently in PR [#75](https://github.com/apache/iceberg-docs/pull/75) against the iceberg-docs repo. Based on that, here's my feedback on the structure here: - The "Getting Started" section here just jumps into a table checklist of what features are supported so at the end of the section, the user still isn't up and running. My suggestion would be to make a very simple docker based quickstart and append it to the quickstarts.md file that I have [here](https://github.com/apache/iceberg-docs/pull/75/files#diff-8218a73a9cf89fe3232fc3210e302a690c5074b7c1c5d0abf8a3329806ac42f8) in PR 75. You can then rename "Getting Started" here to something like "Feature Support" so that the table it contains makes sense. - I opened a draft PR #4801 yesterday to add a "Configurations" section to the docs that serves as a single page where every configuration/property setting is listed. The page will purely be a long list of various tables with property names, potential values, and a description. I've added the Hive/Hadoop related stuff there and if your "Configuration" section includes changes, I think they should be made on that single page and removed here. When relevant in the other pages here, you can link to that single top level "Configurations" page and use the #hadoop-configurations or #hive-configurations tags. That way someone going to `/docs/latest/configurations` can do a quick CMD+F and find a Hive property they're looking for. - That leaves the **Type Compatibility**, **DDL**, and **DML** content which I think all are fitting to place in a Hive docs section (although personally I would put Type Compatibility at the end). With respect to the differences between Hive 2/3/4.0.0-alpha-1, I'm hoping there's some way to consolidate them into a single feature list, and add warning boxes such as "This feature is only available in Hive 4.0.0-alpha-1". To me that feels much better than having a "CREATE TABLE" section for each version. Let me know what you think! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
