Add logo, favicon and footer copy (#3116)

apple · Nov 22, 2024 · 673e4d9 · 673e4d9
1 parent b63aff5
commit 673e4d9
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 4 deletions.
diff --git a/docs/generation/README.adoc b/docs/generation/README.adoc
@@ -1,6 +1,6 @@
 = ServiceTalk Documentation Website
 
-Repo for ServiceTalk's https://pages.github.com/apple/servicetalk/[documentation website].
+Repo for ServiceTalk's https://apple.github.io/servicetalk[documentation website].
 
 The website is built with the https://antora.org[Antora] docsite generator out of https://asciidoctor.org[Asciidoc] docs
 maintained in the https://github.com/apple/servicetalk[upstream project].

diff --git a/docs/generation/supplemental-ui/css/site-extra.css b/docs/generation/supplemental-ui/css/site-extra.css
@@ -13,3 +13,16 @@ code {
 .navigation-container {
     width: 13rem;
 }
+
+header .navbar .navbar-item a {
+    display: flex;
+}
+
+header .navbar .navbar-logo {
+    margin-right: 12px;
+    width: 28px;
+}
+
+.footer p {
+    color: #fff;
+}
diff --git a/docs/generation/supplemental-ui/favicon.ico b/docs/generation/supplemental-ui/favicon.ico
diff --git a/docs/generation/supplemental-ui/img/servicetalk.png b/docs/generation/supplemental-ui/img/servicetalk.png
diff --git a/docs/generation/supplemental-ui/partials/footer-content.hbs b/docs/generation/supplemental-ui/partials/footer-content.hbs
@@ -1,3 +1,6 @@
 <footer class="footer">
-  <p></p>
+  <p>Copyright © <span class="footer-year"></span> Apple Inc. All rights reserved.</p>
+  <script>
+    document.querySelector('.footer-year').textContent = new Date().getFullYear();
+  </script>
 </footer>
diff --git a/docs/generation/supplemental-ui/partials/head-icons.hbs b/docs/generation/supplemental-ui/partials/head-icons.hbs
@@ -0,0 +1 @@
+    <link rel="icon" href="{{{siteRootPath}}}/favicon.ico" type="image/x-icon">
diff --git a/docs/generation/supplemental-ui/partials/header-content.hbs b/docs/generation/supplemental-ui/partials/header-content.hbs
@@ -2,7 +2,10 @@
   <nav class="navbar">
     <div class="navbar-brand">
       <div class="navbar-item">
-        <a href="https://github.com/apple/servicetalk">ServiceTalk</a>
+        <a href="https://github.com/apple/servicetalk">
+          <img class="navbar-logo" src="{{{siteRootPath}}}/_/img/servicetalk.png" alt="ServiceTalk logo" />
+          <span>ServiceTalk</span>
+        </a>
         <span class="separator">//</span>
         <a href="{{or site.url (or siteRootUrl siteRootPath)}}">Docs</a>
       </div>

diff --git a/docs/generation/supplemental-ui/ui.yml b/docs/generation/supplemental-ui/ui.yml
@@ -17,3 +17,4 @@
 static_files:
 - _headers
 - robots.txt
+- favicon.ico
diff --git a/servicetalk-concurrent-api/gradle/checkstyle/suppressions.xml b/servicetalk-concurrent-api/gradle/checkstyle/suppressions.xml
@@ -21,6 +21,10 @@
 <suppressions>
   <suppress checks="LineLength"
     files="docs[\\/]modules[\\/]ROOT[\\/]assets[\\/]images[\\/].+\.svg"/>
+  <suppress checks="LineLength"
+    files="docs[\\/]generation[\\/]supplemental-ui[\\/].+\.ico"/>
+  <suppress checks="LineLength"
+    files="docs[\\/]generation[\\/]supplemental-ui[\\/]img[\\/].+\.src"/>
   <!-- mapOnError supports re-throwing a Throwable from onError(Throwable) -->
   <suppress checks="IllegalThrowsCheck" files="io[\\/]servicetalk[\\/]concurrent[\\/]api[\\/]ScanWithMapper.java"/>
   <suppress checks="IllegalThrowsCheck" files="io[\\/]servicetalk[\\/]concurrent[\\/]api[\\/]ScanMapper.java"/>

diff --git a/...ternal/src/main/groovy/io/servicetalk/gradle/plugin/internal/ServiceTalkCorePlugin.groovy b/...ternal/src/main/groovy/io/servicetalk/gradle/plugin/internal/ServiceTalkCorePlugin.groovy
@@ -90,7 +90,7 @@ class ServiceTalkCorePlugin implements Plugin<Project> {
         source = fileTree(".") {
           includes = ["gradle/**", "*.gradle", "*.properties", "scripts/**", "buildSrc/**", "docs/**"]
           excludes = ["**/gradle/wrapper/**", "**/build/**", "**/.gradle/**", "**/gradlew*", "**/.cache/**",
-                      "**/*.svg", "**/.out/**", "**/node_modules/**", "**/*.png", "**/*.zip"]
+                      "**/*.svg", "**/.out/**", "**/node_modules/**", "**/*.png", "**/*.ico", "**/*.zip", "**/*.ipr"]
         }
       }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<link rel="icon" href="{{{siteRootPath}}}/favicon.ico" type="image/x-icon">