aws-samples / aws-samples/sample-genai-on-eks-starter-kit
docs: align TEI verification instructions with model-specific Services
- Dominant language
- JavaScript
- Stars
- 94
- Forks
- 59
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 8
Description
While reviewing the TEI deployment documentation in the sample-genai-on-eks-starter-kit repository, I noticed a mismatch between the verification instructions in docs/components/embedding-model/tei.md and the current model-specific Kubernetes manifests under components/embedding-model/tei/.
The documentation uses svc/tei with 8080:8080 for port forwarding, while the current model manifests create separate Services for each model, using model-specific Service names and port 80.
As a result, users following the documentation may see the verification command fail as written or may be unsure which Service and port should be used.
Relevant files:S
- docs/components/embedding-model/tei.md
- components/embedding-model/tei/model-*.template.yaml
Contributor guide
Research direction
Start with docs/components/embedding-model/tei.md and compare its verification steps with the model-specific Services in components/embedding-model/tei/model-*.template.yaml. Update the documented Service name and port to match the selected model manifest, then verify that the port-forward and verification command use the same values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100