Merge branch 'awsdocs:main' into aws-nuke-1

Author: ford-at-aws

.doc_gen/metadata/firehose_metadata.yaml

@@ -1,6 +1,14 @@
 # zexi 0.4.0
 firehose_PutRecord:
   languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/firehose
+          excerpts:
+            - description:
+              snippet_tags:
+                - firehose.java2.put_record.main
     Python:
       versions:
         - sdk_version: 3
@@ -14,6 +22,14 @@ firehose_PutRecord:
     firehose: {PutRecord}
 firehose_PutRecordBatch:
   languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/firehose
+          excerpts:
+            - description:
+              snippet_tags:
+                - firehose.java2.put_batch_records.main
     Rust:
       versions:
         - sdk_version: 1
@@ -40,6 +56,14 @@ firehose_Scenario_PutRecords:
   synopsis: use &FH; to process individual and batch records.
   category: Scenarios
   languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/firehose
+          excerpts:
+            - description: This example puts individual and batch records to &FH;.
+              snippet_tags:
+                - firehose.java2.scenario.main
     Python:
       versions:
         - sdk_version: 3

.github/workflows/validate-doc-metadata.yml

@@ -16,7 +16,7 @@ jobs:
       - name: checkout repo content
         uses: actions/checkout@v4
       - name: validate metadata
-        uses: awsdocs/aws-doc-sdk-examples-tools@2024.49.1
+        uses: awsdocs/aws-doc-sdk-examples-tools@2024.50.2
         with:
           doc_gen_only: "False"
           strict_titles: "True"

.tools/readmes/config.py

@@ -27,6 +27,7 @@
     "&kms-key;": "KMS key",
     "&kms-keys;": "KMS keys",
     "&S3long;": "Amazon Simple Storage Service",
+    "&S3only;": "S3",
     "&SLN;": "Amazon States Language",
 }
 language = {

.tools/readmes/includes/code_examples.jinja2

@@ -33,7 +33,14 @@ functions within the same service.
 {{ macs.list_examples(scenarios) }}
 {% endif %}
 {% for cat, cat_examples in custom_cats.items() %}
+{% set cat_info = categories.get(cat) %}
+{% if cat_info %}
+### {{ cat_info.display }}
+{% if cat_info.description %}_{{ cat_info.display }}_ {{ cat_info.description }}{% endif %}
+
+{% else %}
 ### {{ cat }}
+{% endif %}
 
 {{ macs.list_examples(cat_examples) }}
 {% endfor %}

.tools/readmes/render.py

@@ -13,6 +13,7 @@
 from typing import Dict, List, Tuple
 
 import config
+from aws_doc_sdk_examples_tools.categories import Category
 from aws_doc_sdk_examples_tools.entities import expand_all_entities
 from aws_doc_sdk_examples_tools.metadata import Example
 from aws_doc_sdk_examples_tools.sdks import Sdk
@@ -128,6 +129,7 @@ def _transform_examples(
                 "api": api,
                 "category": pre.category,
             }
+            self._apply_defaults_and_overrides(action)
             post_examples.append(action)
         return sorted(post_examples, key=itemgetter(sort_key))
 
@@ -153,22 +155,44 @@ def _find_files(self, example: Example, api: str, github: bool = False):
 
         return file, run_file
 
+    def _make_plain_text(self, s: str, example: Dict[str, str]) -> [str, None]:
+        """Work around strings being Go templates and including XML tags by brute forcing them away."""
+        if s is None:
+            return s
+        return s.replace("<code>", "")\
+            .replace("</code>", "")\
+            .replace("{{.Action}}", example["api"])\
+            .replace("{{.ServiceEntity.Short}}", self.scanner.doc_gen.services[self.scanner.svc_name].short)
+
+    def _apply_defaults_and_overrides(self, example: Dict[str, str]):
+        ex_cat = "Actions" if example["category"] == "Api" else example["category"]
+        cat = self.scanner.doc_gen.categories.get(ex_cat, None)
+        if cat is not None:
+            if cat.overrides:
+                example["title"] = self._make_plain_text(cat.overrides.title, example)
+                example["title_abbrev"] = self._make_plain_text(cat.overrides.title_abbrev, example)
+                example["synopsis"] = self._make_plain_text(cat.overrides.synopsis, example)
+            elif cat.defaults:
+                if not example.get("title"):
+                    example["title"] = self._make_plain_text(cat.defaults.title, example)
+                if not example.get("title_abbrev"):
+                    example["title_abbrev"] = self._make_plain_text(cat.defaults.title_abbrev, example)
+                if not example.get("synopsis"):
+                    example["synopsis"] = self._make_plain_text(cat.defaults.synopsis, example)
+
     def _transform_hellos(self) -> List[Dict[str, str]]:
         examples = self._transform_examples(self.scanner.hellos)
         return examples
 
     def _transform_actions(self) -> List[Dict[str, str]]:
         examples = self._transform_examples(self.scanner.actions, sort_key="api")
         for example in examples:
-            example["title_abbrev"] = example["api"]
             del example["api"]
         return examples
 
     def _transform_basics(self) -> List[Dict[str, str]]:
         examples = self._transform_examples(self.scanner.basics)
         for example in examples:
-            if not example["title_abbrev"]:
-                example["title_abbrev"] = config.basics_title_abbrev
             example["file"] = example["run_file"]
             del example["run_file"]
             del example["api"]
@@ -196,7 +220,8 @@ def _transform_custom_categories(self) -> Dict[str, List[Dict[str, str]]]:
             post_cats[example["category"]].append(example)
 
         sorted_cats = {}
-        for key in sorted(post_cats.keys()):
+        for key in sorted(post_cats.keys(),
+                          key=lambda x: self.scanner.doc_gen.categories.get(x, Category(x, x)).display):
             if len(post_cats[key]) == 0:
                 del sorted_cats[key]
             else:
@@ -295,6 +320,7 @@ def render(self) -> RenderStatus:
             lang_config=self.lang_config,
             sdk=sdk,
             service=svc,
+            categories=self.scanner.doc_gen.categories,
             hello=hello,
             actions=actions,
             basics=basics,

.tools/test/stacks/images/scripts/delete_repository.py

@@ -1,10 +1,10 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
-
-import boto3
 import logging
 import sys
 
+import boto3
+
 
 def delete_selected_public_ecr_repos(delete_images=False):
     """