Skip to content

Conversation

@marythought
Copy link
Contributor

@marythought marythought commented Jan 21, 2026

This PR adds 2 setup scripts and adds a "quickstart" guide to reference those scripts and follow a user story. The new guide will be unlisted for a trial period while we collect feedback on its usability, and may eventually replace the "getting-started" page.

The two scripts do the following:

  1. check that prerequisites are installed
  2. full platform installation

Since the success of the script will vary based on user's operating system, CI tests are added to confirm the script runs on windows, mac and linux

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @marythought, 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 significantly enhances the OpenTDF 'Getting Started' experience by transforming the documentation into a user-story driven tutorial. It introduces two new shell scripts to automate system checks and the full platform installation, making the initial setup much smoother. The updated guide now provides clearer, more practical examples of how attribute-based access control works within the OpenTDF ecosystem, allowing users to quickly grasp core concepts through a relatable scenario.

Highlights

  • User Story-Driven Getting Started Guide: The 'Getting Started' guide has been completely rewritten to follow a practical user story involving Jen, Preston, and Jack, demonstrating attribute-based access control (ABAC) concepts with department and clearance attributes.
  • Automated Pre-flight Checks: A new check.sh script has been introduced to perform automated pre-flight checks, verifying system prerequisites like OS, Docker status, memory, disk space, port availability, and sudo access before installation.
  • Automated OpenTDF Platform Installation: A new install.sh script automates the entire OpenTDF platform setup, including otdfctl CLI installation, Docker configuration, /etc/hosts modification, service startup, and SSL certificate import, significantly simplifying the onboarding process.
  • Enhanced Attribute and Subject Mapping Examples: The guide now features detailed examples of creating department (using ANY_OF rule) and clearance (using HIERARCHY rule) attributes, and subject mappings to illustrate how different users gain or are denied access based on their entitlements.

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

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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 significantly improves the 'Getting Started' guide by introducing a more user-friendly, scenario-based tutorial and automating the setup process with new check.sh and install.sh scripts. The changes make the onboarding experience much smoother. My review includes feedback on the documentation content, such as fixing a TODO and correcting typos in example outputs. I've also identified some issues in the new shell scripts, including incorrect port checks in check.sh and fragile, hardcoded container names in install.sh that could cause the script to fail for users. Addressing these points will make the new getting started experience more robust and reliable.

@marythought marythought changed the title Feat/getting started refresher Feat/getting started refresher DSPX-2316 Jan 23, 2026
@marythought marythought changed the title Feat/getting started refresher DSPX-2316 Feat: quickstart DSPX-2316 Jan 23, 2026
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@marythought marythought force-pushed the feat/getting-started-refresher branch from c127500 to b954b8e Compare January 23, 2026 22:18
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@marythought marythought marked this pull request as ready for review January 23, 2026 22:51
@marythought marythought requested a review from a team as a code owner January 23, 2026 22:51
@marythought marythought changed the title Feat: quickstart DSPX-2316 feat(docs): DSPX-2316 quickstart guide Jan 23, 2026
@marythought marythought changed the title feat(docs): DSPX-2316 quickstart guide feat: DSPX-2316 quickstart guide Jan 23, 2026
@marythought marythought force-pushed the feat/getting-started-refresher branch from c18d6a1 to ee7e915 Compare January 23, 2026 23:10
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@marythought marythought force-pushed the feat/getting-started-refresher branch from ee7e915 to 7992271 Compare January 23, 2026 23:18
$ref: '#/components/schemas/policy.SimpleKasKey'
title: kas_keys
description: Keys associated with the attribute
allowTraversal:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This and all other openapi.yaml file changes were required for a successful CI build as a result of update-vendored-yaml, but are unrelated to the changes in this PR

Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@marythought marythought force-pushed the feat/getting-started-refresher branch from ec014bc to d000f95 Compare January 23, 2026 23:36
@marythought marythought force-pushed the feat/getting-started-refresher branch 2 times, most recently from 2656f1b to 42e4630 Compare January 24, 2026 00:46
@marythought
Copy link
Contributor Author

The Docker tests that confirm the scripts run for various operating systems add about 5 minutes to CI runtime, so we'll only run them when relevant files are touched, and not on every doc change.

@marythought marythought force-pushed the feat/getting-started-refresher branch from 42e4630 to 40c04cb Compare January 24, 2026 00:52
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@marythought marythought force-pushed the feat/getting-started-refresher branch from 40c04cb to d0e82e2 Compare January 24, 2026 01:02
github-actions bot added a commit that referenced this pull request Jan 26, 2026
@marythought marythought force-pushed the feat/getting-started-refresher branch from 32ff80a to 15a3658 Compare January 26, 2026 20:16
@opentdf opentdf deleted a comment from github-actions bot Jan 26, 2026
github-actions bot added a commit that referenced this pull request Jan 26, 2026
@opentdf opentdf deleted a comment from github-actions bot Jan 26, 2026
github-actions bot added a commit that referenced this pull request Jan 26, 2026
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>

use uuid instead of PR number

Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@marythought marythought force-pushed the feat/getting-started-refresher branch from 2f439d7 to 82f5765 Compare January 26, 2026 22:14
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@opentdf opentdf deleted a comment from github-actions bot Jan 27, 2026
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.

3 participants