badalprasadsingh commented on code in PR #2456:
URL: https://github.com/apache/iceberg-go/pull/2456#discussion_r4505235196


##########
CONTRIBUTING.md:
##########
@@ -62,9 +62,14 @@ Integration tests require Docker and are gated behind a 
build tag:
 
 ```bash
 docker compose -f internal/recipe/docker-compose.yml up -d rest object-store 
create-bucket --wait
-go test -tags integration ./...
+export AWS_S3_ENDPOINT=http://localhost:9000 AWS_REGION=us-east-1
+go test -tags integration ./catalog/rest/... ./catalog/sql/... 
./table/maintenance/... ./io/gocloud/s3/...
 ```
 
+Without `AWS_S3_ENDPOINT`, the S3-backed tests send requests to real AWS S3 
and fail (for example with a `301 PermanentRedirect`).
+
+This starts only the REST catalog and object store, so it runs only the 
packages they serve. To run the full suite CI runs (Hive, Azure, GCS and 
Spark), see [Integration tests](README.md#integration-tests) in the README.

Review Comment:
   this works on github, but: docs site includes this file 
(`website/src/contributing.md`), and md book rewrites the link to README.html, 
which doesn't exist on `go.iceberg.apache.org`
   
   better: use the absolute link as other docs pages do
   
   ```md
   see [Integration 
tests](https://github.com/apache/iceberg-go/blob/main/README.md#integration-tests)
 in the README.
   ```
   
   e.g., check 
[this](https://github.com/apache/iceberg-go/blob/2e69b8adb8f0db0ecdd7a48cf4280737f4704fe6/website/src/configuration.md?plain=1#L69)
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to