chore: add SEO meta description (#3202)

yenfryherrerafeliz · web-flow · commit 606298b057ec · 2025-10-28T12:26:34.000-07:00
- Add SEO meta description to each page
- Add also guide-name and service-name metadatas
diff --git a/build/docs/.phpdoc/template/layout.html.twig b/build/docs/.phpdoc/template/layout.html.twig
@@ -2,9 +2,16 @@
 <html lang="en">
     <head>
         <meta charset="utf-8">
-        {% block head %}
-            <title>{% block title %}{{ project.name }}{% endblock %}</title>
-        {% endblock %}
+        <meta name="guide-name" content="API Reference">
+        <meta name="service-name" content="AWS SDK for PHP">
+        <!--
+            Description is added from DocsBuilder by the `updateMetadata` method.
+        -->
+        <meta name="description" content="">
+        <!--
+            Title is added from DocsBuilder by the `updateMetadata` method.
+        -->
+        <title></title>
 
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
         {{ renderBaseUrlHeader() }}
diff --git a/build/docs/classes/DocsBuilder.php b/build/docs/classes/DocsBuilder.php
@@ -139,6 +139,7 @@ public function build()
         if ($this->issueLoggingEnabled) {
             $this->updateIssues();
         }
+        $this->updateMetadataInFiles($this->outputDir);
     }
 
     private function updateHomepage(array $services)
@@ -351,6 +352,7 @@ private function writeThemeFile($name, $contents)
         fwrite(STDOUT, "Writing file: {$name}.\n");
         $updatedTemplate = str_replace('index.html#top', $name . '#top', $this->template);
         $html = str_replace('{{ contents }}', $contents, $updatedTemplate);
+
         return (bool) file_put_contents("{$this->outputDir}/{$name}", $html);
     }
 
@@ -364,6 +366,71 @@ private function replaceInner($name, $replace, $search = '{{ contents }}')
         file_put_contents($path, $contents);
     }
 
+    /**
+     * @param string $name
+     * @param string $html
+     *
+     * @return void
+     */
+    private function updateMetadata(string $name, string &$html): void
+    {
+        // Standardize file name to be capitalized and without .html
+        $normalizedName = implode(
+            '-',
+            array_map('ucfirst',
+                explode('-',
+                    str_replace(
+                        '.',
+                        '-',
+                        str_replace(
+                            '.html',
+                            '',
+                            $name
+                        )
+                    )
+                )
+            )
+        );
+        fwrite(STDOUT, "Adding metadata description to {$name}.\n");
+        $html = str_replace(
+            '<meta name="description" content="">',
+            "<meta name='description' content='$normalizedName'>",
+            $html
+        );
+        // Add title
+        fwrite(STDOUT, "Adding title to {$name}.\n");
+        $html = str_replace(
+            '<title></title>',
+            "<title>$normalizedName - AWS SDK for PHP V3</title>",
+            $html
+        );
+    }
+
+    /**
+     * @param string $outputDir
+     *
+     * @return void
+     */
+    public function updateMetadataInFiles(string $outputDir): void
+    {
+        $dirIterator = new \DirectoryIterator($outputDir);
+        $filter = function ($iterable, callable $pred) {
+            foreach ($iterable as $value) {
+                if ($pred($value)) {
+                    yield $value;
+                }
+            }
+        };
+        $files = $filter($dirIterator, function ($file) {
+            return str_ends_with($file, '.html');
+        });
+        foreach ($files as $file) {
+            $contents = file_get_contents($file->getPathname());
+            $this->updateMetadata($file->getFilename(), $contents);
+            file_put_contents($file->getPathname(), $contents);
+        }
+    }
+
     private function gatherServiceVersions()
     {
         $manifest = __DIR__ . '/../../../src/data/manifest.json';
diff --git a/build/docs/phpdoc.dist.xml b/build/docs/phpdoc.dist.xml
@@ -4,7 +4,7 @@
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://www.phpdoc.org"
 >
-    <title>AWS SDK for PHP 3.x</title>
+    <title>AWS SDK for PHP V3</title>
     <paths>
         <output>../../build/artifacts/docs</output>
     </paths>

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`
`5`	`5`	`xmlns="https://www.phpdoc.org"`
`6`	`6`	`>`
`7`		`- <title>AWS SDK for PHP 3.x</title>`
	`7`	`+ <title>AWS SDK for PHP V3</title>`
`8`	`8`	`<paths>`
`9`	`9`	`<output>../../build/artifacts/docs</output>`
`10`	`10`	`</paths>`