feat: DSPX-2347 improvements to quickstart guide

[marythought]

This PR incorporates feedback from curriculum team and other quickstart testers

Preview environment live at https://opentdf-docs-preview.surge.sh/quickstart

[gemini-code-assist]

Summary of Changes

Hello @marythought, I'm Gemini Code Assist¹! 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 refines the OpenTDF quickstart documentation, making it more robust and user-friendly. It introduces a dedicated guide for managing the OpenTDF platform, streamlines the quickstart installation process with clearer steps and expected outputs, and enhances the explanation of core concepts like Attribute-Based Access Control through visual aids. These changes aim to improve the onboarding experience for new users and provide better support for managing local OpenTDF instances.

Highlights

• New Platform Management Guide: A new dedicated documentation page, 'Managing the Platform', has been added to provide comprehensive instructions on how to start, stop, restart, and check the status of OpenTDF platform services, including troubleshooting TLS certificate verification.
• Enhanced Quickstart Flow: The main Quickstart guide has been significantly improved with a clearer, step-by-step installation process, numbered sections, and better organization of prerequisites.
• Improved Clarity with Expected Outputs: Numerous 'Expected output' sections have been added for various shell commands throughout the Quickstart guide, making it easier for users to verify successful execution and understand command results.
• Visual Aid for ABAC Scenario: A Mermaid flowchart has been integrated into the Quickstart guide to visually illustrate the Attribute-Based Access Control (ABAC) scenario, enhancing comprehension of access decisions.
• Streamlined otdfctl Usage: The documentation now provides more detailed explanations for otdfctl profile creation, default profiles, and authentication persistence, and has removed the explicit --profile flag from most commands for brevity.
• Installer Script Improvements: The check.sh script now includes a check for /etc/hosts writability, and the install.sh script offers more comprehensive guidance and management commands when OpenTDF is already installed.

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

[gemini-code-assist]

Code Review

This pull request significantly improves the quickstart guide by making it more detailed, structured, and user-friendly. The addition of expected outputs for commands, a visual diagram for the scenario, and clearer step-by-step instructions are excellent enhancements. The creation of a separate page for platform management and improvements to the installer's user experience are also valuable. I've identified a bug in the installer script when handling re-installations and a point for clarification in the new platform management guide. Overall, this is a great contribution to improving the onboarding experience for new users.