feat(docs): improve compose file in Getting Started

[b-long]

Current state

• Use the raw-loader to pull in the docker-compose content from a fixed file
  • https://docusaurus.io/docs/markdown-features/react#importing-code-snippets
• Create a Github Action to deploy the compose stack
  • Intentionally fail the build (proving that the current compose stack in documentation is not working)
• Update the docker-compose.yaml
• Validate that the updated docker compose stack is working in CI
  • By validating that it is working in CI, we can have confidence to put it in front of end-users on the Getting Started page.

Future state

• Maintain and test the docker compose stack as a part of the opentdf/platform repository
• Source the file dynamically, retrieving the compose file from the platform to use within the opentdf/docs getting started page

Testing

1. Test the docusaurus changes, using npm install && npm run build && npm run serve. Open your web browser to http://localhost:3000/ , and click "Get Started" to view the updated page (or navigate directly to http://localhost:3000/getting-started ).
2. Test the docker compose file by launching it on your machine:

# If running on Apple M4 chip
JAVA_OPTS_APPEND="-XX:UseSVE=0" docker compose --file docker-compose.yaml up -d

# Or on other architectures
docker compose --file docker-compose.yaml up -d

Access the services:

• Platform configuration: https://platform.opentdf.local:8443/.well-known/opentdf-configuration
• Keycloak: https://keycloak.opentdf.local:9443/auth/

[gemini-code-assist]

Summary of Changes

Hello @b-long, 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 enhances the "Getting Started" documentation by externalizing the Docker Compose configuration into its own file and dynamically embedding it into the Docusaurus page. This change improves the maintainability of the documentation and ensures that the example Docker Compose setup is consistently presented and easily updated.

Highlights

• Docker Compose Configuration: A new "docker-compose.yaml" file has been added to the "docs/getting-started" directory, providing a complete multi-service setup for a local OpenTDF environment, including Caddy, Keycloak, PostgreSQL, and the OpenTDF platform.
• Documentation Structure Improvement: The "docs/getting-started/index.mdx" file now dynamically imports and displays the content of the "docker-compose.yaml" using "raw-loader" and a Docusaurus "CodeBlock" component, replacing a large, hardcoded YAML block.
• New Dependency: The "raw-loader" package has been added to "package.json" and "package-lock.json" to facilitate the dynamic loading of the Docker Compose file content into the documentation.

🧠 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 refactors the Getting Started documentation by moving the Docker Compose configuration into a separate file, which is a great improvement for maintainability. I've reviewed the new docker-compose.yaml file and found several areas for improvement, primarily concerning security and best practices. My main concerns are the use of world-writable permissions (777), hardcoded default passwords, and unpinned Docker image versions. I've provided specific suggestions to address these issues.

[rzubi-virtru]

I've just gone through this process and tested it on my local machine and it worked for me.