-
Notifications
You must be signed in to change notification settings - Fork 2
feat: DSPX-2316 quickstart guide #172
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @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
🧠 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. 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
|
There was a problem hiding this 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.
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
c127500 to
b954b8e
Compare
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
c18d6a1 to
ee7e915
Compare
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
ee7e915 to
7992271
Compare
| $ref: '#/components/schemas/policy.SimpleKasKey' | ||
| title: kas_keys | ||
| description: Keys associated with the attribute | ||
| allowTraversal: |
There was a problem hiding this comment.
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>
ec014bc to
d000f95
Compare
2656f1b to
42e4630
Compare
|
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. |
42e4630 to
40c04cb
Compare
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
40c04cb to
d0e82e2
Compare
32ff80a to
15a3658
Compare
Signed-off-by: Mary Dickson <mary.dickson@virtru.com> use uuid instead of PR number Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
This reverts commit b3ebc3d.
2f439d7 to
82f5765
Compare
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
… command injection
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:
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