rmoff commented on code in PR #13491:
URL: https://github.com/apache/iceberg/pull/13491#discussion_r2209989373


##########
docs/mkdocs.yml:
##########
@@ -22,69 +22,79 @@ plugins:
 
 nav:
   - index.md
-  - Tables:
-    - branching.md
-    - configuration.md
-    - evolution.md
-    - maintenance.md
-    - metrics-reporting.md
-    - partitioning.md
-    - performance.md
-    - reliability.md
-    - schemas.md
-  - Views:
-    - view-configuration.md
-  - Spark:
-    - spark-getting-started.md
-    - spark-configuration.md
-    - spark-ddl.md
-    - spark-procedures.md
-    - spark-queries.md
-    - spark-structured-streaming.md
-    - spark-writes.md
-  - Flink:
-    - flink.md
-    - flink-connector.md
-    - flink-ddl.md
-    - flink-queries.md
-    - flink-writes.md
-    - flink-actions.md
-    - flink-configuration.md
-  - hive.md
-  - Trino: https://trino.io/docs/current/connector/iceberg.html
-  - Daft: daft.md
-  - Firebolt: 
https://docs.firebolt.io/reference-sql/functions-reference/table-valued/read_iceberg
-  - Estuary: 
https://docs.estuary.dev/reference/Connectors/materialization-connectors/apache-iceberg/
-  - Tinybird: 
https://www.tinybird.co/docs/forward/get-data-in/table-functions/iceberg
-  - Redpanda: 
https://docs.redpanda.com/current/manage/iceberg/about-iceberg-topics
-  - RisingWave: risingwave.md
-  - ClickHouse: 
https://clickhouse.com/docs/en/engines/table-engines/integrations/iceberg
-  - Presto: https://prestodb.io/docs/current/connector/iceberg.html
-  - Dremio: https://docs.dremio.com/data-formats/apache-iceberg/
-  - Starrocks: 
https://docs.starrocks.io/en-us/latest/data_source/catalog/iceberg_catalog
-  - Amoro: amoro.md
-  - Amazon Athena: 
https://docs.aws.amazon.com/athena/latest/ug/querying-iceberg.html
-  - Amazon EMR: 
https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-iceberg-use-cluster.html
-  - Amazon Data Firehose: 
https://docs.aws.amazon.com/firehose/latest/dev/apache-iceberg-destination.html
-  - Amazon Redshift: 
https://docs.aws.amazon.com/redshift/latest/dg/querying-iceberg.html
-  - Google BigQuery: https://cloud.google.com/bigquery/docs/iceberg-tables
-  - Snowflake: https://docs.snowflake.com/en/user-guide/tables-iceberg
-  - Impala: 
https://impala.apache.org/docs/build/html/topics/impala_iceberg.html
-  - Databend: https://docs.databend.com/guides/access-data-lake/iceberg
-  - Doris: https://doris.apache.org/docs/dev/lakehouse/catalogs/iceberg-catalog
-  - Druid: 
https://druid.apache.org/docs/latest/development/extensions-contrib/iceberg/
-  - DuckDB: https://duckdb.org/docs/preview/core_extensions/iceberg/overview
-  - Kafka Connect: kafka-connect.md
+  - Concepts:
+    - Tables:
+      - branching.md
+      - configuration.md
+      - evolution.md
+      - maintenance.md
+      - metrics-reporting.md
+      - partitioning.md
+      - performance.md
+      - reliability.md
+      - schemas.md
+    - Views:
+      - view-configuration.md
+  - Libraries:
+    - Java:
+      - Quickstart: java-api-quickstart.md
+      - API: api.md
+      - Javadoc: ../../javadoc/latest/
+    - Python: https://py.iceberg.apache.org/
+    - Rust: https://rust.iceberg.apache.org/
+    - Go: https://pkg.go.dev/github.com/apache/iceberg-go/
   - Integrations:
-    - aws.md
-    - dell.md
+    # Iceberg-maintained integrations come first
+    - Apache Hive: hive.md
+    - Spark:
+      - spark-getting-started.md
+      - spark-configuration.md
+      - spark-ddl.md
+      - spark-procedures.md
+      - spark-queries.md
+      - spark-structured-streaming.md
+      - spark-writes.md
+    - Flink:
+      - flink.md
+      - flink-connector.md
+      - flink-ddl.md
+      - flink-queries.md
+      - flink-writes.md
+      - flink-actions.md
+      - flink-configuration.md
+    - Kafka Connect: kafka-connect.md
+    - Third-party:
+    # Now all the 3rd party integrations
+      - Apache Amoro: amoro.md
+      - Amazon Athena: 
https://docs.aws.amazon.com/athena/latest/ug/querying-iceberg.html
+      - Amazon Data Firehose: 
https://docs.aws.amazon.com/firehose/latest/dev/apache-iceberg-destination.html
+      - Amazon EMR: 
https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-iceberg-use-cluster.html
+      - Amazon Redshift: 
https://docs.aws.amazon.com/redshift/latest/dg/querying-iceberg.html
+      - Apache Doris: 
https://doris.apache.org/docs/dev/lakehouse/catalogs/iceberg-catalog
+      - Apache Druid: 
https://druid.apache.org/docs/latest/development/extensions-contrib/iceberg/
+      - ClickHouse: 
https://clickhouse.com/docs/en/engines/table-engines/integrations/iceberg
+      - Daft: daft.md
+      - Databend: https://docs.databend.com/guides/access-data-lake/iceberg
+      - Dremio: https://docs.dremio.com/data-formats/apache-iceberg/
+      - DuckDB: 
https://duckdb.org/docs/preview/core_extensions/iceberg/overview
+      - Estuary: 
https://docs.estuary.dev/reference/Connectors/materialization-connectors/apache-iceberg/
+      - Firebolt: 
https://docs.firebolt.io/reference-sql/functions-reference/table-valued/read_iceberg
+      - Google BigQuery: https://cloud.google.com/bigquery/docs/iceberg-tables
+      - Impala: 
https://impala.apache.org/docs/build/html/topics/impala_iceberg.html
+      - Presto: https://prestodb.io/docs/current/connector/iceberg.html
+      - Redpanda: 
https://docs.redpanda.com/current/manage/iceberg/about-iceberg-topics
+      - RisingWave: risingwave.md
+      - Snowflake: https://docs.snowflake.com/en/user-guide/tables-iceberg
+      - Starrocks: 
https://docs.starrocks.io/en-us/latest/data_source/catalog/iceberg_catalog
+      - Tinybird: 
https://www.tinybird.co/docs/forward/get-data-in/table-functions/iceberg
+      - Trino: https://trino.io/docs/current/connector/iceberg.html
+  - Catalogs:

Review Comment:
   I think it's important that the docs are easy to use, and I would favour the 
primary categorisation being the type of tool, and secondary its ownership 
relative to the project. In this mock here, the user wants to see a Catalog, 
and so can find that, and _then_ navigate between project and 3rd party. Would 
this be a good solution @manuzhang ?
   
   <img width="250" alt="CleanShot 2025-07-16 at 11 34 02@2x" 
src="https://github.com/user-attachments/assets/afa7064b-f417-4d54-9872-096d7f11b708";
 />
   
   Whereas if it's embedded within `Integrations` the navigation is confusing 
for the user because there is more than one place for them to find a Catalog.
   
   <img width="250"  alt="CleanShot 2025-07-16 at 11 41 05@2x" 
src="https://github.com/user-attachments/assets/b2e911df-0b7b-4b58-b04a-c296d6dedaf0";
 />
   
   ---
   
   Alternatively, we ditch the categorisations that I've proposed, and just put 
_everything_ under `Integrations`, and then in a separate PR implement a 
comprehensive list of catalogs and at that point finalise a suitable hierarchy 
in the navigation for presenting them.
   I am less in favour of this because it makes it less easy for users to 
navigate.
   <img width="250"  alt="CleanShot 2025-07-16 at 11 50 11@2x" 
src="https://github.com/user-attachments/assets/52dd34f1-193c-420e-9dce-77a3dd80c8b9";
 />
   
   



-- 
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: issues-unsubscr...@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org

Reply via email to