Skip to content

Conversation

@Laren-AWS
Copy link
Contributor

Add SDK and Category fields used by the publishing frontend to allow for customization of the display:

  • sdk.display defines a string to display instead of the SDK key value so that a longer display string can be defined that's separate from the key.
  • sdk.is_pseudo_sdk indicates whether the SDK is a true AWS SDK or something else. When true, the pseudo SDK is not included in the Code Library "by SDK" chapter.
  • sdk.version.suppress_version_heading when true, suppresses the SDK version heading inside the tablist.
  • category.synopsis_prefix defines strings for the synopsis prefix instead of the default "This code example shows how to".
  • category.more_info defines a string that is used at the bottom of an example beneath the tablist that direct the reader to more information about the specific category of example.

These fields have already been incorporated into the backend ZonBook processor.

Testing

  • Unit tests
  • Root repo validation
  • Internal builds

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@Laren-AWS Laren-AWS marked this pull request as ready for review March 5, 2025 22:34
@Laren-AWS Laren-AWS self-assigned this Mar 5, 2025
@Laren-AWS Laren-AWS added the Task A general update to the code base for language clarification, missing actions, tests, etc. label Mar 5, 2025
@Laren-AWS Laren-AWS requested a review from DavidSouther March 5, 2025 22:34
@Laren-AWS Laren-AWS added Enhancement A general update to the code base. and removed Task A general update to the code base for language clarification, missing actions, tests, etc. labels Mar 5, 2025
@Laren-AWS Laren-AWS force-pushed the feat/add-sdk-cat-fields branch from 4641e59 to 24f74f9 Compare March 5, 2025 22:42
@Laren-AWS Laren-AWS merged commit 2b92493 into main Mar 5, 2025
2 checks passed
@Laren-AWS Laren-AWS deleted the feat/add-sdk-cat-fields branch March 5, 2025 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Enhancement A general update to the code base.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants