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

   ### What changes were proposed in this pull request?
   
   Adds two concept pages and reduces two existing pages to the API surface.
   
   New: `docs/tags.md` and `docs/policies.md`. Each covers what the object is, 
which
   metadata object types can carry one, how inheritance resolves and how to 
tell a
   direct attachment from an inherited one, the privileges involved, and how to 
work
   with it in the UI.
   
   Changed: `manage-tags-in-gravitino.md` and `manage-policies-in-gravitino.md` 
keep
   their slugs and now cover the API only. The concept material moves to the new
   pages, and each links to its counterpart. The tag page gains Python examples 
for
   every operation, which it never had, and the policy page states that the 
Python
   client does not cover policies. The curl tab is relabeled from Shell to REST,
   keeping `value="shell"` so tab sync and existing `?language=shell` links 
still
   work.
   
   The two new pages are not in the sidebar yet. `sidebars.ts` lives in
   gravitino-site, so a companion PR there makes them reachable.
   
   ### Why are the changes needed?
   
   Tags and policies had no concept page anywhere in the doc set. 
Catalog-delivered
   object types get a concept page plus a "Manage X" API page, but these two 
got only
   the API layer, so what a tag is, what can carry one, and how inheritance 
resolves
   were buried in an `:::info` block partway down an API reference.
   
   Several claims on the old pages were also wrong or missing. Policies cover 
six
   object types and tags nine, which neither page contrasted. The `enabled` 
flag is a
   marker Gravitino does not act on, which was stated 200 lines below where a 
reader
   creates one. Only service admins can create metalakes and only owners can 
alter
   policies, which no page mentioned.
   
   ### Does this PR introduce _any_ user-facing change?
   
   Documentation only. No API, property, or behavior changes. Two new pages at
   `/tags` and `/policies`; the two existing pages keep their slugs, so no links
   break.
   
   ### How was this patch tested?
   
   Every claim was checked against the source rather than carried over from the
   existing pages, including the taggable and policy-able type sets in 
`TagManager`
   and `PolicyManager`, the privilege bindings in `Privileges`, the 
authorization
   expressions on the REST operations, and the 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