dimas-b commented on code in PR #2599: URL: https://github.com/apache/polaris/pull/2599#discussion_r2357272141
########## README.md: ########## @@ -45,20 +45,56 @@ Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/instal ## Project Structure Apache Polaris is organized into the following modules: - -- [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic -- API modules (implementing the Iceberg REST API and Polaris management API): - - `polaris-api-management-model` - The Polaris management model - - `polaris-api-management-service` - The Polaris management service - - `polaris-api-iceberg-service` - The Iceberg REST service -- Runtime modules: - - `polaris-runtime-service` - The runtime components of the Polaris server - - `polaris-runtime-defaults` - The runtime configuration defaults - - `polaris-server` - The Polaris server - - `polaris-admin` - The Polaris admin & maintenance tool -- Persistence modules: - - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface - - `polaris-relational-jdbc` - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager +- Primary modules: + - [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic + - [API modules](./api/README.md) - Implements the Iceberg REST API and Polaris Management APIs: + - `polaris-api-management-model` - Polaris Management API model classes + - `polaris-api-management-service` - Polaris Management API service classes + - `polaris-api-iceberg-service` - The Iceberg REST service classes + - `polaris-api-catalog-service` - The Polaris Catalog API service classes + - Runtime modules: + - [`polaris-admin`](./runtime/admin/README.md) - The Polaris Admin Tool + - `polaris-runtime-common` - A package holding QuarkusRelationalJdbcConfiguration Review Comment: We can probably drop this from this README. IIRC, its purpose is to share some code between JDBC persistence and other modules, but given that it only holds one class, it might be possible to fold it into other module... in any case, it does not look like a "primary" module :) WDYT? ########## README.md: ########## @@ -45,20 +45,56 @@ Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/instal ## Project Structure Apache Polaris is organized into the following modules: - -- [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic -- API modules (implementing the Iceberg REST API and Polaris management API): - - `polaris-api-management-model` - The Polaris management model - - `polaris-api-management-service` - The Polaris management service - - `polaris-api-iceberg-service` - The Iceberg REST service -- Runtime modules: - - `polaris-runtime-service` - The runtime components of the Polaris server - - `polaris-runtime-defaults` - The runtime configuration defaults - - `polaris-server` - The Polaris server - - `polaris-admin` - The Polaris admin & maintenance tool -- Persistence modules: - - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface - - `polaris-relational-jdbc` - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager +- Primary modules: + - [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic + - [API modules](./api/README.md) - Implements the Iceberg REST API and Polaris Management APIs: Review Comment: I'm not sure those API modules implement anything... these are mostly just build scripts for generating the java bindings for the various Open API specs :thinking: ########## README.md: ########## @@ -45,20 +45,56 @@ Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/instal ## Project Structure Apache Polaris is organized into the following modules: - -- [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic -- API modules (implementing the Iceberg REST API and Polaris management API): - - `polaris-api-management-model` - The Polaris management model - - `polaris-api-management-service` - The Polaris management service - - `polaris-api-iceberg-service` - The Iceberg REST service -- Runtime modules: - - `polaris-runtime-service` - The runtime components of the Polaris server - - `polaris-runtime-defaults` - The runtime configuration defaults - - `polaris-server` - The Polaris server - - `polaris-admin` - The Polaris admin & maintenance tool -- Persistence modules: - - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface - - `polaris-relational-jdbc` - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager +- Primary modules: + - [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic + - [API modules](./api/README.md) - Implements the Iceberg REST API and Polaris Management APIs: + - `polaris-api-management-model` - Polaris Management API model classes + - `polaris-api-management-service` - Polaris Management API service classes + - `polaris-api-iceberg-service` - The Iceberg REST service classes + - `polaris-api-catalog-service` - The Polaris Catalog API service classes + - Runtime modules: + - [`polaris-admin`](./runtime/admin/README.md) - The Polaris Admin Tool + - `polaris-runtime-common` - A package holding QuarkusRelationalJdbcConfiguration + - [`polaris-runtime-defaults`](./runtime/defaults/README.md) - The runtime configuration defaults + - [`polaris-distribution`](./runtime/distribution/README.md) - The Polaris distribution + - [`polaris-server`](./runtime/server/README.md) - The Polaris Quarkus Server + - [`polaris-runtime-service`](./runtime/service/README.md) - The package containing the Polaris service. + - `polaris-runtime-spark-tests` - Integration tests for the Polaris Spark plugin + - `polaris-runtime-test-common` - Test utilities + - Persistence modules: + - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface + - `polaris-relational-jdbc` - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager + - Extensions modules: + - `polaris-extensions-federation-hadoop` - The Hadoop federation extension + - [`polaris-extensions-federation-hive`](./extensions/federation/hive/README.md) - The Hive federation extension +- Secondary modules: + - `agregated-license-report` - Generates the aggregated license report + - `polaris-bom` - The Bill of Materials (BOM) for Polaris + - `polaris-build-logic` - Establishes consistent build logic + - [`polaris-tests`](./integration-tests/README.md) - Integration tests Review Comment: suggestion: `Normative integration tests for reuse in downstream projects` ########## README.md: ########## @@ -45,20 +45,56 @@ Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/instal ## Project Structure Apache Polaris is organized into the following modules: - -- [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic -- API modules (implementing the Iceberg REST API and Polaris management API): - - `polaris-api-management-model` - The Polaris management model - - `polaris-api-management-service` - The Polaris management service - - `polaris-api-iceberg-service` - The Iceberg REST service -- Runtime modules: - - `polaris-runtime-service` - The runtime components of the Polaris server - - `polaris-runtime-defaults` - The runtime configuration defaults - - `polaris-server` - The Polaris server - - `polaris-admin` - The Polaris admin & maintenance tool -- Persistence modules: - - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface - - `polaris-relational-jdbc` - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager +- Primary modules: + - [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic + - [API modules](./api/README.md) - Implements the Iceberg REST API and Polaris Management APIs: + - `polaris-api-management-model` - Polaris Management API model classes + - `polaris-api-management-service` - Polaris Management API service classes + - `polaris-api-iceberg-service` - The Iceberg REST service classes + - `polaris-api-catalog-service` - The Polaris Catalog API service classes + - Runtime modules: + - [`polaris-admin`](./runtime/admin/README.md) - The Polaris Admin Tool Review Comment: suggestion: `The Polaris Admin Tool (mainly used for bootstrapping persistence)` ########## README.md: ########## @@ -45,20 +45,56 @@ Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/instal ## Project Structure Apache Polaris is organized into the following modules: - -- [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic -- API modules (implementing the Iceberg REST API and Polaris management API): - - `polaris-api-management-model` - The Polaris management model - - `polaris-api-management-service` - The Polaris management service - - `polaris-api-iceberg-service` - The Iceberg REST service -- Runtime modules: - - `polaris-runtime-service` - The runtime components of the Polaris server - - `polaris-runtime-defaults` - The runtime configuration defaults - - `polaris-server` - The Polaris server - - `polaris-admin` - The Polaris admin & maintenance tool -- Persistence modules: - - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface - - `polaris-relational-jdbc` - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager +- Primary modules: + - [`polaris-core`](./polaris-core/README.md) - The main Polaris entity definitions and core business logic + - [API modules](./api/README.md) - Implements the Iceberg REST API and Polaris Management APIs: + - `polaris-api-management-model` - Polaris Management API model classes + - `polaris-api-management-service` - Polaris Management API service classes + - `polaris-api-iceberg-service` - The Iceberg REST service classes + - `polaris-api-catalog-service` - The Polaris Catalog API service classes + - Runtime modules: + - [`polaris-admin`](./runtime/admin/README.md) - The Polaris Admin Tool + - `polaris-runtime-common` - A package holding QuarkusRelationalJdbcConfiguration + - [`polaris-runtime-defaults`](./runtime/defaults/README.md) - The runtime configuration defaults + - [`polaris-distribution`](./runtime/distribution/README.md) - The Polaris distribution + - [`polaris-server`](./runtime/server/README.md) - The Polaris Quarkus Server + - [`polaris-runtime-service`](./runtime/service/README.md) - The package containing the Polaris service. + - `polaris-runtime-spark-tests` - Integration tests for the Polaris Spark plugin + - `polaris-runtime-test-common` - Test utilities + - Persistence modules: + - `polaris-eclipselink` - The Eclipselink implementation of the MetaStoreManager interface + - `polaris-relational-jdbc` - The JDBC implementation of BasePersistence to be used via AtomicMetaStoreManager + - Extensions modules: + - `polaris-extensions-federation-hadoop` - The Hadoop federation extension + - [`polaris-extensions-federation-hive`](./extensions/federation/hive/README.md) - The Hive federation extension +- Secondary modules: + - `agregated-license-report` - Generates the aggregated license report + - `polaris-bom` - The Bill of Materials (BOM) for Polaris + - `polaris-build-logic` - Establishes consistent build logic + - [`polaris-tests`](./integration-tests/README.md) - Integration tests +- Tool modules: + - Documentation configuration: + - `polaris-config-docs-annotations` - Annotations for documentation generator + - `polaris-config-docs-generator` - Generates Polaris reference docs + - `polaris-config-docs-site` - The configuration documentation site + - Other Tools: + - `polaris-container-spec-helper` - Helper for container specifications + - `polaris-immutables` - Immutables for Polaris Review Comment: suggestion: `Predefined Immutables configuration / annotations for Polaris` -- 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]
