Conversation
There was a problem hiding this comment.
Pull request overview
Adds end-user and admin documentation for the new Trino-powered Query Engine and the Service Operations UI, and wires them into the MkDocs navigation.
Changes:
- Add a user guide page for the Query Engine (Trino) UI, including screenshots and best practices.
- Add admin documentation for managing Trino and for monitoring async Service Operations.
- Update
mkdocs.ymlnavigation and add new screenshot assets.
Reviewed changes
Copilot reviewed 4 out of 21 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds nav links for the new Query Engine and Service Operations docs. |
| docs/user_guides/projects/trino/query_engine.md | New user-facing Query Engine (Trino) guide with screenshots. |
| docs/setup_installation/admin/trino.md | New admin guide for cluster overview, query history, workers, and config variables. |
| docs/setup_installation/admin/operationLogs.md | New admin guide for async Service Operations and related configuration. |
| docs/assets/images/guides/trino/query-details-ref.png | Adds screenshot used by the user guide. |
| docs/assets/images/admin/trino/workers.png | Adds screenshot used by the admin Trino guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mkdocs.yml
Outdated
| - ArrowFlight Server with DuckDB: setup_installation/common/arrow_flight_duckdb.md | ||
| - Service Operations: setup_installation/admin/operationLogs.md | ||
| - Query Engine: setup_installation/admin/trino.md |
There was a problem hiding this comment.
The two new admin pages are added at the same navigation level as "ArrowFlight Server with DuckDB" (i.e., outside the existing "Administration" section). This makes the sidebar structure inconsistent with the rest of the admin docs and likely hides them from the expected section. Consider moving these entries under the existing - Administration: nav group (around lines 236–266).
| - ArrowFlight Server with DuckDB: setup_installation/common/arrow_flight_duckdb.md | |
| - Service Operations: setup_installation/admin/operationLogs.md | |
| - Query Engine: setup_installation/admin/trino.md | |
| - Service Operations: setup_installation/admin/operationLogs.md | |
| - Query Engine: setup_installation/admin/trino.md | |
| - ArrowFlight Server with DuckDB: setup_installation/common/arrow_flight_duckdb.md |
| The references tab lists all tables and data sources accessed by the query, helping you understand data dependencies. | ||
|
|
||
| <figure> | ||
| <img src="../../../../assets/images/guides/trino/query-details-ref.png" alt="Query details referances" /> |
There was a problem hiding this comment.
Typo in the image alt text: "referances" should be "references".
| <img src="../../../../assets/images/guides/trino/query-details-ref.png" alt="Query details referances" /> | |
| <img src="../../../../assets/images/guides/trino/query-details-ref.png" alt="Query details references" /> |
| **Available Variables:** | ||
|
|
||
| - **trino_enabled**: Enable or disable Trino cluster-wide (default: `true`) | ||
| - **trino_default_catalog**: Default catalog used for superset queries (default: `hive`) |
There was a problem hiding this comment.
Apache Superset is a proper name and is capitalized elsewhere in the docs. This bullet says "superset queries"; consider changing to "Superset queries" for consistency.
| - **trino_default_catalog**: Default catalog used for superset queries (default: `hive`) | |
| - **trino_default_catalog**: Default catalog used for Superset queries (default: `hive`) |
1 participant
No description provided.