Skip to content

docs(aws): clarify generated External ID behavior for key and role credentials#1156

Draft
llewellyn-sl wants to merge 1 commit intomasterfrom
edu-1025-aws-external-id-docs
Draft

docs(aws): clarify generated External ID behavior for key and role credentials#1156
llewellyn-sl wants to merge 1 commit intomasterfrom
edu-1025-aws-external-id-docs

Conversation

@llewellyn-sl
Copy link
Contributor

@llewellyn-sl llewellyn-sl commented Feb 25, 2026

Summary

  • document AWS credential modes in Cloud and Enterprise compute-environment docs
  • clarify External ID behavior from credential creation flow
  • specify that External ID is optional for key-based credentials and mandatory for role-based credentials
  • add/align trust policy examples using sts:ExternalId
  • keep existing-credentials compatibility notes
  • keep TOWER_ALLOW_CREDENTIALS note scoped to Enterprise docs only

Jira

  • EDU-1025

Notes

  • This PR updates docs only (no product code changes).

@netlify
Copy link

netlify bot commented Feb 25, 2026

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit 9445520
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/699f1830af1238000829eb07
😎 Deploy Preview https://deploy-preview-1156--seqera-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@llewellyn-sl
Copy link
Contributor Author

@claude please review

@claude
Copy link

claude bot commented Feb 26, 2026

Claude finished @llewellyn-sl's task —— View job


AWS External ID Documentation Review ✅

I've completed a thorough review of your AWS External ID documentation changes across all 6 files. Here's my comprehensive analysis:

Files Reviewed:

  • platform-cloud/docs/compute-envs/aws-batch.md
  • platform-cloud/docs/compute-envs/aws-cloud.md
  • platform-cloud/docs/compute-envs/eks.md
  • platform-enterprise_docs/compute-envs/aws-batch.md
  • platform-enterprise_docs/compute-envs/aws-cloud.md
  • platform-enterprise_docs/compute-envs/eks.md

Overall Assessment: Excellent

Your documentation changes successfully address AWS credential modes and External ID behavior with high consistency and technical accuracy.

✅ Strengths

1. Perfect Content Consistency

  • Identical External ID sections across all 6 files ensures uniform user experience
  • Clear distinction between key-based vs role-based credentials
  • Proper explanation of when External ID is optional vs mandatory

2. Technical Accuracy

  • Correctly explains that Platform generates External ID for key-based credentials
  • Properly states External ID is mandatory for role-based credentials
  • Accurate description of cross-account security use case

3. Excellent Structure

  • Clean tabbed interface for credential types
  • Logical flow from credential selection to External ID explanation
  • Consistent formatting and organization across files

4. Voice & Tone Compliance

  • Maintains second person perspective throughout
  • Uses clear, confident language
  • Follows established documentation patterns

🟡 Minor Issues Found (3 total)

Issue 1: Subject-Verb Agreement

File: aws-cloud.md (both Cloud & Enterprise versions)
Line: ~9
Current: "AWS cloud compute environments allows you to..."
Fix: "AWS cloud compute environments allow you to..."
Priority: Medium - grammatical error

Issue 2: Passive Voice Clarity

File: aws-batch.md (both versions)
Line: ~88
Current: "Compute environment instances launched with this key pair allow for direct SSH access."
Suggested: "This key pair allows direct SSH access to compute environment instances."
Priority: Low - stylistic improvement

Issue 3: Minor Terminology Inconsistency

All files: Mixed capitalization of "External ID" vs "external ID" within same paragraphs
Suggested: Use consistent capitalization throughout
Priority: Low - minor inconsistency

✅ Documentation Standards Compliance

  • Formatting: Excellent Markdown structure and consistent styling
  • Links: Proper cross-references to credential setup docs
  • Organization: Logical information hierarchy
  • User Experience: Clear instructions and helpful context
  • Consistency: Perfect alignment between Cloud and Enterprise versions

🎯 Recommendation

Approve with minor fixes. The documentation effectively addresses the EDU-1025 requirements and provides clear guidance on AWS credential configuration. The identified issues are minor and don't impact the technical accuracy or user comprehension.

The new External ID sections are well-integrated and will help users understand the security implications and proper configuration of their AWS credentials.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant