docs(policy): deprecate non-namespaced registered resources#253
docs(policy): deprecate non-namespaced registered resources#253alkalescent wants to merge 7 commits intomainfrom
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request primarily focuses on updating the documentation to reflect the deprecation of non-namespaced registered resources within the policy system. It introduces the concept of namespaced registered resources, provides clear examples of their Fully Qualified Names (FQNs), and outlines the necessary migration steps for existing resources. These changes ensure that the documentation aligns with the evolving policy architecture, guiding users towards the recommended, namespaced approach for managing registered resources. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively documents the deprecation of non-namespaced registered resources. The changes are consistent across all modified files, updating definitions, examples, and diagrams to reflect that registered resources are now namespaced. The documentation is clearer and more accurate as a result. I have one suggestion to further improve the migration instructions to make them more actionable for users.
|
📄 Preview deployed to https://opentdf-docs-pr-253.surge.sh |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughIntroduces namespacing for Registered Resources across docs and vocabularies, updates FQN formats and deprecation notices for non‑namespaced resources, documents an Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
docs/components/policy/registered_resources.md (1)
1-1:⚠️ Potential issue | 🟡 MinorSwitch this modified policy page to
.mdxformat.This file is updated as
.md, which conflicts with the documentation format rule.As per coding guidelines,
**/*.{md,mdx}: Documentation files should use.mdxformat; name new pageskebab-case.mdx, and useindex.mdxfor section landing pages.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/components/policy/registered_resources.md` at line 1, This documentation page is currently saved as a .md file but must follow the project's docs rule to use .mdx; rename the file from registered_resources.md to kebab-case .mdx (e.g., registered-resources.mdx) or, if this is a section landing page, to index.mdx inside a folder, and update any internal frontmatter or import usage to the .mdx filename; ensure the top-level heading "Registered Resources" remains and that the file extension and name follow the repository's .mdx naming conventions.docs/components/policy/attributes.md (1)
1-1:⚠️ Potential issue | 🟡 MinorConvert this updated doc page to
.mdx.The file is modified as
.md, but the documentation convention requires.mdx.As per coding guidelines,
**/*.{md,mdx}: Documentation files should use.mdxformat; name new pageskebab-case.mdx, and useindex.mdxfor section landing pages.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/components/policy/attributes.md` at line 1, The doc page titled "Attributes" is currently written as a .md file; rename and convert it to a .mdx file using the docs convention (use kebab-case for new page names, e.g., attributes.mdx) or if this is a section landing page turn it into index.mdx, and ensure the file content is valid MDX (retain the "Attributes" heading and any frontmatter) so it follows the **/*.{md,mdx} documentation guideline.docs/components/authorization.md (1)
1-3:⚠️ Potential issue | 🟡 MinorUse
.mdxfor this documentation page.This file is being modified as Markdown (
.md), but docs standards require.mdxfor documentation files.As per coding guidelines,
**/*.{md,mdx}: Documentation files should use.mdxformat; name new pageskebab-case.mdx, and useindex.mdxfor section landing pages.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/components/authorization.md` around lines 1 - 3, The documentation page "authorization.md" is in the wrong format; rename and convert it to MDX by changing the filename to a kebab-case .mdx (e.g., authorization.mdx) or to index.mdx if this is a section landing page, update frontmatter and any MD-specific constructs to MDX-compatible syntax, and ensure the docs build/config references the new .mdx file instead of the .md file.docs/components/policy/index.md (1)
1-4:⚠️ Potential issue | 🟡 MinorPlease migrate this updated policy doc to
.mdx.The changed page remains
.md, which conflicts with the docs file-format rule.As per coding guidelines,
**/*.{md,mdx}: Documentation files should use.mdxformat; name new pageskebab-case.mdx, and useindex.mdxfor section landing pages.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/components/policy/index.md` around lines 1 - 4, The file docs/components/policy/index.md is still in .md and needs to be migrated to .mdx: rename the page to use .mdx (use index.mdx for this section landing page) and move/convert any frontmatter or markdown content into the new .mdx file while preserving the existing YAML frontmatter fields (sidebar_position and slug) or converting them to MDX-compatible export metadata; ensure the filename follows the docs rule (section landing pages use index.mdx) and update any internal imports/links that referenced docs/components/policy/index.md to point to docs/components/policy/index.mdx.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/components/authorization.md`:
- Around line 1-3: The documentation page "authorization.md" is in the wrong
format; rename and convert it to MDX by changing the filename to a kebab-case
.mdx (e.g., authorization.mdx) or to index.mdx if this is a section landing
page, update frontmatter and any MD-specific constructs to MDX-compatible
syntax, and ensure the docs build/config references the new .mdx file instead of
the .md file.
In `@docs/components/policy/attributes.md`:
- Line 1: The doc page titled "Attributes" is currently written as a .md file;
rename and convert it to a .mdx file using the docs convention (use kebab-case
for new page names, e.g., attributes.mdx) or if this is a section landing page
turn it into index.mdx, and ensure the file content is valid MDX (retain the
"Attributes" heading and any frontmatter) so it follows the **/*.{md,mdx}
documentation guideline.
In `@docs/components/policy/index.md`:
- Around line 1-4: The file docs/components/policy/index.md is still in .md and
needs to be migrated to .mdx: rename the page to use .mdx (use index.mdx for
this section landing page) and move/convert any frontmatter or markdown content
into the new .mdx file while preserving the existing YAML frontmatter fields
(sidebar_position and slug) or converting them to MDX-compatible export
metadata; ensure the filename follows the docs rule (section landing pages use
index.mdx) and update any internal imports/links that referenced
docs/components/policy/index.md to point to docs/components/policy/index.mdx.
In `@docs/components/policy/registered_resources.md`:
- Line 1: This documentation page is currently saved as a .md file but must
follow the project's docs rule to use .mdx; rename the file from
registered_resources.md to kebab-case .mdx (e.g., registered-resources.mdx) or,
if this is a section landing page, to index.mdx inside a folder, and update any
internal frontmatter or import usage to the .mdx filename; ensure the top-level
heading "Registered Resources" remains and that the file extension and name
follow the repository's .mdx naming conventions.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d4d78d79-1ebf-47b7-8c5e-68d0566c3fda
📒 Files selected for processing (6)
.github/vale-styles/config/vocabularies/Opentdf/accept.txtdocs/components/authorization.mddocs/components/policy/attributes.mddocs/components/policy/index.mddocs/components/policy/registered_resources.mddocs/sdks/policy.mdx
| When a Registered Resource is associated with a namespace, the FQN takes the form `https://<namespace>/reg_res/<registered_resource.name>/value/<registered_resource_value.value>`. | ||
|
|
||
| :::warning Deprecation | ||
| Non-namespaced Registered Resources are deprecated. Their FQNs use the form `https://reg_res/<registered_resource.name>/value/<registered_resource_value.value>`. A future version will require all Registered Resources to be associated with a namespace. Use the `otdfctl migrate registered-resources` command to migrate existing non-namespaced Registered Resources. |
There was a problem hiding this comment.
Are they deprecated? Or do we just recommend that you don't create non-namespaced RRs?
There was a problem hiding this comment.
I thought we were deprecating non namespaced policy (like why we originally made namespaces required for some policy objects). My understanding was that due to breaking changes we were making namespaces optional to give consumers a grace period and avoid breaking changes. I may have understood incorrectly, or my understanding may be outdated? I'll reach out to the team for clarification.
| The `otdfctl migrate registered-resources` command migrates legacy non-namespaced Registered Resources to namespaced ones. | ||
|
|
||
| :::caution | ||
| Migration creates a new namespaced resource, recreates its values with their action-attribute-value mappings, then deletes the old non-namespaced resource. The migrated resource will have a new UUID. Back up your data before running with `--commit`. |
There was a problem hiding this comment.
I think we are changing this to not delete the old, but add a metadata tag that we can then use with a prune or cleanup command.
There was a problem hiding this comment.
Okay, what would you recommend? I'm thinking I can keep this block as current behavior but mention future expected behavior. Alternatively, I can just remove mention of migration until we get to an expected state.
2 participants
This PR documents the deprecation of non-namespaced registered resources and how to migrate existing resources using otdfctl.
Summary by CodeRabbit
New Features
Documentation