What would you like to be improved?
While publishing the 1.3.1 documentation to gravitino-site, an automated review flagged several defects in docs/. I have confirmed each still exists on main, so they affect the next release too.
Incorrect information
docs/topics.md — the Kafka broker default is num.partitions, not num.partition. Users following this will look up a property that does not exist.docs/functions.md — states that Spark uses a Python implementation, but the Spark UDF guide says only Java implementations with RuntimeType.SPARK are supported and Python cannot be invoked.docs/topics.md — the access-control table lists Topic as a valid grant target for CREATE_TOPIC; docs/security/access-control.md limits it to Metalake, Catalog and Schema.docs/filesets.md — same problem for CREATE_FILESET, which lists Fileset as a grant target.
OpenAPI specification
docs/open-api/credentials.yaml — a media type schema references components.responses, which is not a Schema Object. This makes the published document invalid.docs/open-api/datatype.yaml — an example omits the required catalogString and supplies an undefined externalType property, so it fails strict example validation.docs/open-api/policies.yaml — the operation description omits COLUMN, although the request schema accepts it.docs/open-api/idp/openapi.yaml — still reports version: 1.3.0-SNAPSHOT. It shipped that way in 1.3.1, so clients read the wrong API version.
Broken links
docs/table-maintenance-service/optimizer-extension-guide.md — the CLI Reference link points at the configuration page instead of optimizer-cli-reference.md.docs/iceberg-rest-catalog-chart.md and docs/lance-rest-server-chart.md — relative links to ../dev/charts/... resolve inside this repo but break on the published site. Present since 1.0.0.
How should we improve?
Fix each in docs/ so the corrections flow into the next release. The wrong-information items are worth prioritising, since they lead users to configurations that cannot work.
The 1.3.0-SNAPSHOT version string also suggests the release process does not update that file — worth checking whether it should be templated like the main specification.
Visitar URL original
What would you like to be improved?
While publishing the 1.3.1 documentation to gravitino-site, an automated review flagged several defects in
docs/. I have confirmed each still exists onmain, so they affect the next release too.Incorrect information
docs/topics.md— the Kafka broker default isnum.partitions, notnum.partition. Users following this will look up a property that does not exist.docs/functions.md— states that Spark uses a Python implementation, but the Spark UDF guide says only Java implementations withRuntimeType.SPARKare supported and Python cannot be invoked.docs/topics.md— the access-control table lists Topic as a valid grant target forCREATE_TOPIC;docs/security/access-control.mdlimits it to Metalake, Catalog and Schema.docs/filesets.md— same problem forCREATE_FILESET, which lists Fileset as a grant target.OpenAPI specification
docs/open-api/credentials.yaml— a media typeschemareferencescomponents.responses, which is not a Schema Object. This makes the published document invalid.docs/open-api/datatype.yaml— an example omits the requiredcatalogStringand supplies an undefinedexternalTypeproperty, so it fails strict example validation.docs/open-api/policies.yaml— the operation description omitsCOLUMN, although the request schema accepts it.docs/open-api/idp/openapi.yaml— still reportsversion: 1.3.0-SNAPSHOT. It shipped that way in 1.3.1, so clients read the wrong API version.Broken links
docs/table-maintenance-service/optimizer-extension-guide.md— the CLI Reference link points at the configuration page instead ofoptimizer-cli-reference.md.docs/iceberg-rest-catalog-chart.mdanddocs/lance-rest-server-chart.md— relative links to../dev/charts/...resolve inside this repo but break on the published site. Present since 1.0.0.How should we improve?
Fix each in
docs/so the corrections flow into the next release. The wrong-information items are worth prioritising, since they lead users to configurations that cannot work.The
1.3.0-SNAPSHOTversion string also suggests the release process does not update that file — worth checking whether it should be templated like the main specification.