feat(sdk): improve docs + code clarity #29658

Job	Run time
setup	13s
Build and Push DataHub Upgrade Docker Image	0s
Build and Push DataHub MCE Consumer Docker Image	0s
Build and Push DataHub GMS Docker Image	0s
Build and Push DataHub MAE Consumer Docker Image	0s
Build and Push DataHub Elasticsearch Setup Docker Image	0s
Build and Push DataHub Frontend Docker Image	0s
Build and Push DataHub Kafka Setup Docker Image	0s
Build and Push DataHub MySQL Setup Docker Image	0s
Build and Push DataHub Ingestion (Base) Docker Image	29s
smoke_test_matrix	3s
[Monitoring] Scan DataHub Upgrade images for vulnerabilities	0s
[Monitoring] Scan GMS images for vulnerabilities	0s
[Monitoring] Scan MCE consumer images for vulnerabilities	0s
[Monitoring] Scan MAE consumer images for vulnerabilities	0s
[Monitoring] Scan ElasticSearch setup images for vulnerabilities	0s
[Monitoring] Scan Frontend images for vulnerabilities	0s
[Monitoring] Scan Kafka Setup images for vulnerabilities	0s
[Monitoring] Scan MySQL Setup images for vulnerabilities	0s
Build and Push DataHub Ingestion (Base-Full) Docker Image	1m 15s
Build and Push DataHub Ingestion (Base-Slim) Docker Image	28s
Build and Push DataHub Ingestion Docker Images	3m 48s
Build and Push DataHub Ingestion (Full) Docker Images	5m 15s
[Monitoring] Scan Datahub Ingestion Slim images for vulnerabilities	2m 51s
Run Smoke Tests (pytests, 0, 3)	18m 33s
Run Smoke Tests (pytests, 3, 1)	22m 6s
Run Smoke Tests (pytests, 3, 2)	24m 41s
[Monitoring] Scan Datahub Ingestion images for vulnerabilities	3m 57s
Deploy to Datahub HEAD	0s
	1h 23m 39s

Provide feedback