Skip to content

Conversation

@ruokun-niu
Copy link
Contributor

This pull request updates the Getting Started tutorial documentation to improve clarity, organization, and user guidance for different setup environments. The changes enhance the instructions for accessing the Debug Reaction UI using k8s ingress.

Environment-specific instructions and improved organization:

  • Added tabbed sections throughout the tutorial to provide clear, step-by-step instructions tailored for Github Codespaces, VSCode DevContainer, and Local Setup, including renamed tab headers for consistency.

Debug Reaction UI access and ingress setup:

  • Expanded instructions for accessing the Debug Reaction Web UI, including ingress configuration specific to each environment, and added guidance for making ports public in Codespaces.
  • Updated the sample output of the drasi list reaction command to display the ingress URL, clarifying how to access the deployed Reaction.

Testing and database connection guidance:

  • Provided environment-specific instructions for connecting to the PostgreSQL database and running SQL commands, including both CLI and GUI options, with improved tabbed navigation for clarity.

Signed-off-by: ruokun-niu <[email protected]>
Signed-off-by: ruokun-niu <[email protected]>
Signed-off-by: ruokun-niu <[email protected]>
Signed-off-by: ruokun-niu <[email protected]>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request enhances the Getting Started tutorial documentation by adding environment-specific instructions and improving the guidance for accessing the Debug Reaction UI through ingress configuration. The changes provide clearer organization through tabbed sections and better support for different development environments.

  • Renamed tab headers for consistency (e.g., "GitHub Codespace" to "Github Codespaces")
  • Added comprehensive ingress setup instructions for local environments (AKS/EKS, Kind, k3d)
  • Enhanced Debug Reaction UI access instructions with environment-specific guidance including Codespaces port configuration

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment on lines 451 to 452
{{% tab header="Github Codespaces" text=true %}}
The Github Codespace is pre-configured with [psql](https://www.postgresql.org/docs/current/app-psql.html), the PostgreSQL CLI, which will connect to the pre-installed PostgreSQL database. If you run the following command from a Dev Container terminal, it will create an interactive terminal session with the database in which you can enter SQL commands and see the results:
Copy link

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

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

Corrected capitalization of 'GitHub' to maintain consistency with official branding.

Suggested change
{{% tab header="Github Codespaces" text=true %}}
The Github Codespace is pre-configured with [psql](https://www.postgresql.org/docs/current/app-psql.html), the PostgreSQL CLI, which will connect to the pre-installed PostgreSQL database. If you run the following command from a Dev Container terminal, it will create an interactive terminal session with the database in which you can enter SQL commands and see the results:
{{% tab header="GitHub Codespaces" text=true %}}
The GitHub Codespace is pre-configured with [psql](https://www.postgresql.org/docs/current/app-psql.html), the PostgreSQL CLI, which will connect to the pre-installed PostgreSQL database. If you run the following command from a Dev Container terminal, it will create an interactive terminal session with the database in which you can enter SQL commands and see the results:

Copilot uses AI. Check for mistakes.
ruokun-niu and others added 3 commits October 29, 2025 09:23
…iu/docs into getting-started-ingress

* 'getting-started-ingress' of https://github.com/ruokun-niu/docs:
  Apply suggestion from @Copilot
  Apply suggestion from @Copilot
  Apply suggestion from @Copilot
  Update docs/content/getting-started/_index.md
@ruokun-niu ruokun-niu merged commit 082ac7c into drasi-project:main Oct 29, 2025
3 of 4 checks passed
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