Skip to content

docs(policy): deprecate non-namespaced registered resources#253

Draft
alkalescent wants to merge 3 commits intomainfrom
DSPX-2496-rr-ns
Draft

docs(policy): deprecate non-namespaced registered resources#253
alkalescent wants to merge 3 commits intomainfrom
DSPX-2496-rr-ns

Conversation

@alkalescent
Copy link
Contributor

This PR documents the deprecation of non-namespaced registered resources and how to migrate existing resources using otdfctl.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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

  • Deprecation of Non-Namespaced Registered Resources: Non-namespaced Registered Resources are now officially deprecated, with a future version requiring all Registered Resources to be associated with a namespace.
  • Migration Path Documented: Documentation now includes instructions on how to migrate existing non-namespaced Registered Resources using the otdfctl migrate registered-resources command.
  • FQN Examples Updated: Fully Qualified Name (FQN) examples for Registered Resources have been updated across the documentation to reflect the new namespaced structure and explicitly mark the deprecated non-namespaced format.
  • Namespace Scope Expansion: Namespaces are now explicitly documented as organizational containers for both attributes and optionally for registered resources, clarifying their expanded role.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions
Copy link
Contributor

📄 Preview deployed to https://opentdf-docs-pr-253.surge.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant