Docsy Upgrade

googleforgames · Oct 10, 2023 · 7cddf58 · 7cddf58
1 parent f8d57c4
commit 7cddf58
Show file tree

Hide file tree

Showing 8 changed files with 81 additions and 37 deletions.
diff --git a/site/assets/scss/_variables_project.scss b/site/assets/scss/_variables_project.scss
@@ -4,9 +4,6 @@ Add styles or override variables from the theme here.
 
 */
 
-$display1-weight: 500 !default;
-$display2-weight: 100 !default;
-
 
 $primary: rgb(255, 255,255)  !default;
 $primary-light: lighten($primary, 75%) !default;
@@ -35,6 +32,8 @@ $td-sidebar-tree-root-color: #222 !default;
     display: none;
 }
 
+// Front page items
+
 .asciinema-theme-asciinema .asciinema-terminal {
     color: #cccccc;
     background-color: #121314;
@@ -46,6 +45,16 @@ $td-sidebar-tree-root-color: #222 !default;
     background-color:black !important;
 }
 
+.showcase img {
+    margin: 0 30px;
+}
+
+#cover-title {
+    max-width: 800px;
+}
+
+// End Front page items
+
 #agones-search {
     background: rgba(190, 185, 185, 0.3);
 }
@@ -61,6 +70,28 @@ input[type="search"]::placeholder {
     color: #121314 !important;
 }
 
-.showcase img {
-    margin: 0 30px;
+.td-search__icon {
+    color: #9B9595 !important;
+}
+
+.search-bar {
+    width: 300px;
+    height: 40px;
+}
+
+.nav-link {
+    margin-right: 20px !important;
+}
+
+// Bring this over from older Bootstrap.
+h1.display-1 {
+    font-size: 3rem;
+    font-weight: 500;
+    line-height: 1.2;
+}
+
+p.display-2 {
+    font-size: 2.5rem;
+    font-weight: 100;
+    line-height: 1.2;
 }
diff --git a/site/config.toml b/site/config.toml
@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC All Rights Reserved.
+# Copyright 2023 Google LLC All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,9 +16,6 @@ baseURL = "/site/"
 title = "Agones"
 enableRobotsTXT = true
 
-# Hugo allows theme composition (and inheritance). The precedence is from left to right.
-theme = ["docsy"]
-
 # Will give values to .Lastmod etc.
 enableGitInfo = true
 
@@ -171,3 +168,9 @@ no = 'Sorry to hear that. Please <a href="https://github.com/googleforgames/agon
 
 [security.funcs]
   getenv = ['^HUGO_', '^CI$', 'RELEASE_BRANCH', 'HUGO_ENV', 'RELEASE_VERSION']
+[module]
+proxy = "direct"
+[[module.imports]]
+path = "github.com/google/docsy"
+[[module.imports]]
+path = "github.com/google/docsy/dependencies"
diff --git a/site/content/en/_index.html b/site/content/en/_index.html
@@ -20,33 +20,32 @@
 {{< /blocks/cover >}}
 
 {{% blocks/lead color="secondary" %}}
-<strong>What is Agones?</strong>
+<p><strong>What is Agones?</strong></p>
 
-An open source, batteries-included, multiplayer dedicated game server scaling and
-orchestration platform that can run anywhere <a class="text-primary" href="https://kubernetes.io">Kubernetes</a> can run.
+<p>An open source, batteries-included, multiplayer dedicated game server scaling and
+orchestration platform that can run anywhere <a class="text-primary" href="https://kubernetes.io">Kubernetes</a> can run.</p>
 {{% /blocks/lead %}}
 
-{{< blocks/section color="dark" >}}
+{{< blocks/section color="dark" type="row" >}}
 {{% blocks/feature icon="fas fa-file-code" title="Orchestrate Game Servers" url="./docs/getting-started/" %}}
-Define and manage groups of ready gameservers through YAML configuration or API calls.
+<p>Define and manage groups of ready gameservers through YAML configuration or API calls.</p>
 {{% /blocks/feature %}}
 
 {{% blocks/feature icon="fas fa-wrench" title="Integrate any Engine" url="./docs/guides/client-sdks/" %}}
-Integrated SDK for managing game server lifecycle, health and configuration.
+<p>Integrated SDK for managing game server lifecycle, health and configuration.
 
-Tools for local development included!
+Tools for local development included!</p>
 {{% /blocks/feature %}}
 
 
 {{% blocks/feature icon="fas fa-chart-area" title="Metrics and Monitoring" url="./docs/guides/metrics/" %}}
-Integration with [OpenCensus](https://opencensus.io/)
-for platform-independent game server metrics and monitoring dashboards
+<p>Integration with <a href="https://opencensus.io/">OpenCensus</a>
+for platform-independent game server metrics and monitoring dashboards</p>
 {{% /blocks/feature %}}
 
-
 {{< /blocks/section >}}
 
-{{< blocks/section color="primary" >}}
+{{< blocks/section color="primary" type="row" >}}
 <div class="col">
 	<h2 class="text-center pb-3">Companies using Agones</h2>
 	<p class="text-center showcase">
@@ -69,7 +68,7 @@ <h2 class="text-center pb-3">Companies using Agones</h2>
 </div>
 {{< /blocks/section >}}
 
-{{< blocks/section color="secondary"  >}}
+{{< blocks/section color="secondary" type="row" >}}
 {{% blocks/feature icon="fab fa-slack" title="Join us on Slack" url="https://join.slack.com/t/agones/shared_invite/enQtMzE5NTE0NzkyOTk1LWU3ODAyZjdjMjNlYWIxZTAwODkxMGY3YWEyZjNjMjc4YWM1Zjk0OThlMGU2ZmUyMzRlMDljNDJiNmZlMGQ1M2U" url_text="Join us" %}}
 Join the community on Slack
 {{% /blocks/feature %}}
@@ -86,4 +85,3 @@ <h2 class="text-center pb-3">Companies using Agones</h2>
 {{% /blocks/feature %}}
 
 {{< /blocks/section >}}
-
diff --git a/site/go.mod b/site/go.mod
@@ -1,5 +1,7 @@
 module github.com/agones/agones/site
 
-go 1.20
+go 1.22
 
-require gopkg.in/yaml.v2 v2.2.8
+require gopkg.in/yaml.v2 v2.4.0
+
+require github.com/google/docsy v0.7.1 // indirect
diff --git a/site/go.sum b/site/go.sum
@@ -1,4 +1,9 @@
+github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
+github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY=
+github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc=
+github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
+github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
-gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
diff --git a/site/layouts/partials/navbar.html b/site/layouts/partials/navbar.html
@@ -2,10 +2,10 @@
 <nav class="js-navbar-scroll navbar navbar-expand navbar-light {{ if not $cover }} nav-shadow {{ end }}flex-column flex-md-row td-navbar">
 
 	<a id="agones-top" {{ if $cover }} style="display: none;" {{end}} class="navbar-brand" href="{{ .Site.Home.RelPermalink }}">
-		{{ with resources.Get "icons/logo.svg" }}{{ ( . | minify).Content | safeHTML }} {{ end }}<span class="text-uppercase font-weight-bold">{{ .Site.Title }}</span>
+		{{ with resources.Get "icons/logo.svg" }}{{ ( . | minify).Content | safeHTML }} {{ end }}<span class="text-uppercase fw-bold">{{ .Site.Title }}</span>
 	</a>
 
-	<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
+	<div class="td-navbar-nav-scroll ms-md-auto" id="main_navbar">
 		<ul class="navbar-nav mt-2 mt-lg-0">
 			{{ $p := . }}
 			{{ range .Site.Menus.main }}
@@ -21,7 +21,7 @@
 				<a class="nav-link" href="{{ .Site.Params.github_repo }}">GitHub</a>
 			</li>
 			<li class="nav-item dropdown d-none d-lg-block">
-				<a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+				<a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
 					Release
 				</a>
 				<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">

diff --git a/site/layouts/partials/search-input.html b/site/layouts/partials/search-input.html
@@ -1,3 +1,8 @@
-{{ with .Site.Params.gcs_engine_id }}
- <input id="agones-search" type="search" class="form-control td-search-input" placeholder="&#xf002 {{ T "ui_search" }}" aria-label="{{ T "ui_search" }}" autocomplete="off">
-{{ end }}
+{{ if .Site.Params.gcs_engine_id -}}
+
+<div class="td-search">
+  <div class="td-search__icon"></div>
+  <input id="agones-search" type="search" class="td-search__input form-control td-search-input" placeholder="{{ T "ui_search" }}" aria-label="{{ T "ui_search" }}" autocomplete="off">
+</div>
+
+{{- end -}}
diff --git a/site/layouts/shortcodes/blocks/cover.html b/site/layouts/shortcodes/blocks/cover.html
@@ -3,23 +3,23 @@
 {{ $height := .Get "height" | default "max"  }}
 <section class="row td-cover-block td-cover-block--height-{{ $height }} js-td-cover td-overlay td-overlay--light -bg-{{ $col_id }}">
   <div class="container td-overlay__inner">
-    <div class="row align-items-end">
-      <div class="col-lg-6">
+    <div class="row justify-content-center align-items-end">
+      <div class="col col-lg-4" id="cover-title">
           <h1 class="display-1 mt-0 pb-3">
             <img alt="agones" width="98" src="images/logo.svg" />
               Agones
           </h1>
           <p class="display-2 mb-0">Host, Run and Scale dedicated game servers on Kubernetes</p>
       </div>
-      <div class="col-lg-6 mt-5 mt-lg-3 d-sm-block" style="display: none">
-          <asciinema-player 
+      <div class="col col-lg-auto mt-1 mt-lg-3 d-none d-md-block">
+          <asciinema-player
           loop autoplay font-size="12px" rows=12 cols=60
           src="agones.cast"></asciinema-player>
       </div>
       <div class="col-12 pt-3">
           <div class="pt-3 lead text-center">
               {{ .Inner }}
-            </div>  
+          </div>
       </div>
     </div>
   </div>