markhoerth opened a new pull request, #12327:
URL: https://github.com/apache/gravitino/pull/12327

   ### What changes were proposed in this pull request?
   
   Adds concept pages for the metadata objects that had none, and reduces the
   corresponding `manage-*` pages to the Gravitino API.
   
   New pages: `catalogs-and-schemas.md`, `tables-and-views.md`, `filesets.md`,
   `topics.md`, `functions.md`, `statistics.md`, and `jobs.md`. Each covers 
what the
   object is, how it behaves, its permissions, and what the UI can and cannot 
do with
   it.
   
   New API page: `manage-catalogs-and-schemas.md`. Catalog and schema 
operations were
   documented separately on the relational, fileset, model, and messaging 
pages, four
   near-identical copies. They now live once.
   
   Reduced to the API: `manage-relational-metadata-using-gravitino.md` (1257 
lines to
   254), `manage-fileset-metadata-using-gravitino.md` (965 to 246),
   `manage-user-defined-function-using-gravitino.md` (705 to 297), and
   `manage-messaging-metadata-using-gravitino.md` (307 to 158). Each keeps its 
slug,
   drops its catalog and schema sections, and links to its concept page.
   
   Follows the same split as #12326, which did tags and policies.
   
   ### Why are the changes needed?
   
   Catalog-delivered object types get a concept page plus an API page, but 
filesets,
   topics, functions, statistics, and jobs had only the API layer, so what an 
object
   is and how it behaves was scattered through an API reference or absent.
   
   The `manage-*` pages also repeated catalog and schema CRUD four times, 
roughly 700
   lines of duplication, and every copy started a reader four sections away 
from the
   object they came for.
   
   Several facts were wrong or missing and are now stated, having been checked 
against
   source: schemas take property changes only, catalog drop takes `force` while 
schema
   drop takes `cascade`, fileset and model catalogs take no provider, dropping a
   managed fileset deletes its files while an external one keeps them, purge is
   rejected on external tables, Kafka catalogs present one fixed `default` 
schema, and
   the Python client does not cover topics, where `as_topic_catalog()` raises
   `UnsupportedOperationException`.
   
   ### Does this PR introduce _any_ user-facing change?
   
   Documentation only. No API, property, or behavior changes. Seven new pages; 
every
   existing page keeps its slug, so no links break. The new pages are not in the
   sidebar yet, since `sidebars.ts` lives in gravitino-site and they will be 
added
   with the wider docs reorganization.
   
   ### How was this patch tested?
   
   Every claim was checked against the source rather than carried over from the
   existing pages: type sets and validation in the catalog, fileset, topic, and
   function managers; privilege bindings in `Privileges.java`; drop and purge
   semantics in `TableCatalog`; the Kafka connector's schema handling and topic
   property metadata; and client method coverage in `clients/client-java` and
   `clients/client-python`. UI behavior was checked against `web-v2`. 
Cross-page links
   were verified to resolve against files in the repo.


-- 
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]

Reply via email to