(polaris) branch main updated: Docs: fix Polaris Guide Testing docs (#5373)

[ad...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

adutra pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git


The following commit(s) were added to refs/heads/main by this push:
     new f43a4f8e5d Docs: fix Polaris Guide Testing docs (#5373)
f43a4f8e5d is described below

commit f43a4f8e5d86ae933537921a2a07952c78bbc03d
Author: Alexandre Dutra <ad...@apache.org>
AuthorDate: Wed Aug 26 11:01:46 2026 +0200

    Docs: fix Polaris Guide Testing docs (#5373)
---
 site/it/README.md | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/site/it/README.md b/site/it/README.md
index 81bfe3f088..815b33164c 100644
--- a/site/it/README.md
+++ b/site/it/README.md
@@ -19,17 +19,17 @@
 
 # Polaris Guide Testing
 
-This repository contains tools and scripts for testing Apache Spark guides.
+This repository contains tools and scripts for testing Apache Polaris getting-started guides.
 It provides a framework for running automated tests against guide content,
 ensuring that at least the basic functionality works.
 
 ## Overview
 
-Guide testing is performed via the "entry" shell script `site_guide_ci.sh`,
+Guide testing is performed via the "entry" Python script `markdown-testing.py`,
 which can also be invoked locally.
 
-The "entry" script calls a Python tool to extract the code blocks from a
-guide's Markdown file and write it to a temporary file as a bash script.
+The "entry" script extracts the code blocks from a
+guide's Markdown file and writes them to a temporary file as a bash script.
 Only `shell` code blocks are extracted, see [Spark SQL](#spark-sql-code) below. 
 
 The "entry" script then executes the generated bash script.
@@ -84,7 +84,7 @@ The code block will be executed but not appear in the guide.
   `docker compose up` command.
 * `curl` command invocations get the `--fail-with-body` option.
   Adding either the `--fail` or `--fail-with-body` option should be considered for
-  ever usage of `curl`, otherwise `curl` will exit with code 0 for error responses
+  every usage of `curl`, otherwise `curl` will exit with code 0 for error responses
   like 401 or 404 and others. 
 * `spark-sql` invocations get the SQL statements to execute via a file that is generated
   from the following `sql` code blocks.
@@ -103,7 +103,8 @@ unifies both into one execution of Spark SQL.
 
 ## GitHub Workflow
 
-The GitHub workflow `site_guide_ci.yml` is used to run the guide tests on pull requests.
+The GitHub CI workflow has a `test-site-guides` job that is used to run the guide tests on pull 
+requests.
 
 The executed generated bash scripts and the corresponding log files are uploaded as
 GitHub workflow artifacts.