docs: update layout of documentation main page theme (#175)

Makefile

@@ -13,7 +13,7 @@ ifdef COLOR_SUPPORT
     RESET := $(shell tput sgr0)
   endif
 endif
-		
+
 .PHONY: docs-build-local
 docs-build-local: ## Build the docs to run locally as a container image, tagged with version and alias (ex: docs:v1.0.0, docs:latest). Usage: `make docs-build-local VERSION=v1.0.0 ALIAS=latest`
 	@if [ -z "${VERSION}" ]; then echo -e "${RED}VERSION is not set. Example: 'docs-build-local VERSION=v1.0.0 ALIAS=latest'. Run 'make help' for usage. ${RESET}"; exit 1; fi
@@ -24,11 +24,10 @@ docs-build-local: ## Build the docs to run locally as a container image, tagged
 		--build-arg GIT_USER_EMAIL="${GIT_USER_EMAIL}" \
 		--build-arg VERSION="${VERSION}" \
 		--build-arg ALIAS="${ALIAS}" \
-		--no-cache
 
 .PHONY: docs-install-dependencies
 docs-install-dependencies: ## Install dependencies required for the docs. Usage: `make docs-install-dependencies VERSION=v1.0.0 ALIAS=latest`
-	pip install -r ./docs/requirements.txt 
+	pip install -r ./docs/requirements.txt
 
 .PHONY: docs-deploy-github
 docs-deploy-github: ## Deploy the docs to remote branch in github. Usage: `docs-deploy-github VERSION=v1.0.0 ALIAS=latest`
@@ -49,4 +48,4 @@ docs-run: ## Run a built docs container image locally. Usage: `make docs-run VER
 .PHONY: help
 help: ## Display this help
 	@echo -e "Usage: make [TARGET]\n"
-	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "${CYAN}%-30s${RESET} %s\n", $$1, $$2}'
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "${CYAN}%-30s${RESET} %s\n", $$1, $$2}'

THIRD-PARTY-LICENSES

@@ -0,0 +1,70 @@
+** Spaceship Prompt - https://github.com/spaceship-prompt/spaceship-prompt - Project documentation sourced from and inspired by.
+
+MIT License
+
+Copyright (c) 2024-2016 [Denys Dovhan](https://denysdovhan.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+====================================================================================================================================================================
+
+** Material for MkDocs - https://github.com/squidfunk/mkdocs-material - Project documentation is built using mkdocs-material. Layout for documentation sourced and inspired by.
+
+Copyright (c) 2016-2024 Martin Donath <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+
+====================================================================================================================================================================
+
+** Powertools for AWS Lambda (Python) - https://github.com/aws-powertools/powertools-lambda-python - Project structure, governance, and documentation sourced from and inspired by.
+
+MIT No Attribution
+
+Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+====================================================================================================================================================================

docs/assets/ansible-playbooks/ansible-playbooks.md

@@ -0,0 +1 @@
+--8<-- "assets/ansible-playbooks/README.md"

docs/assets/jenkins-pipelines/jenkins-pipelines.md

@@ -0,0 +1 @@
+# Jenkins Pipelines

docs/index.md

@@ -1,38 +1,44 @@
-# Welcome to the Cloud Game Development Toolkit
+---
+template: index.html
+title: Cloud Game Development Toolkit
+hide: [navigation]
+hero:
+  title: Tools and best practices for deploying game development infrastructure on AWS
+  subtitle: Get started with ready-to-use templates or use only what you need
+  getting_started_button: Getting Started
+  source_button: Source Code
+features:
+  - title: Assets
+    #image: media/images/assets.png
+    description: Foundational resources such as image templates, configurations scripts, and CI/CD pipeline definitions for game development.
+  - title: Modules
+    #image: media/images/modules.png
+    description: Terraform Modules for deploying common game dev workloads with best-practices by default.
+  - title: Samples
+    #image: media/images/samples.png
+    description: Opinionated ready-to-use implementations to address common use cases for expedited game studio setup and battle-tested scenarios from the community.
+companies:
+  title:
+  list:
+---
 
-The **Cloud Game Development Toolkit (a.k.a. CGD Toolkit)** is a collection of templates and configurations for deploying game development infrastructure and tools on AWS.
+# Welcome to the Cloud Game Development Toolkit
 
 !!! info
     **This project is under active development and community contributions are welcomed!**. If you would like to see something in this repository please create a <a href="https://github.com/aws-games/cloud-game-development-toolkit/issues/new?assignees=&labels=feature-request&projects=&template=feature_request.yml&title=Feature+request%3A+TITLE" target="_blank">feature request</a> in the Issues tab. If you'd like to contribute, raise a <a href="https://github.com/aws-games/cloud-game-development-toolkit/pulls/" target="_blank">pull request</a>. You'll find our contribution guidelines [here](./contributing.md).
 
-## Introduction
-
-The **CGD Toolkit** consists of three key components:
-
-<div class="grid cards" markdown>
-
-- :fontawesome-regular-file-code: [__Assets__](./assets/index.html)
-
-    ---
-
-    Foundational resources such as image templates, configurations scripts, and CI/CD pipeline definitions for game development.
-
-    [:octicons-arrow-right-24: Assets](./assets/index.html)
-
-- :fontawesome-solid-cube: [__Modules__](./modules/index.html)
-
-    ---
-
-    Infrastructure as code (we use [Terraform](https://www.terraform.io/)) for deploying common game dev workloads with best-practices by default. These typically consume assets.
+The **Cloud Game Development Toolkit (a.k.a. CGD Toolkit)** is a collection of templates and configurations for deploying game development infrastructure and tools on AWS.
 
-    [:octicons-arrow-right-24: Modules](./modules/index.html)
+Below are key principles and goals driving project's focus:
 
-- :fontawesome-solid-cubes: [__Samples__](./samples/index.html)
+- **This is a fork-first, open-source project**. We know that every game project is unique, so fork the repo, create your own branches for customization and sync as appropriate. If you build something that can benefit other game developers, feel free to share via PR, as we encourage contributions!
+- **Meet game developers where they are**. We aim to minimize the introduction of new tools and technologies by building solutions that incorporate widely used software from across the game industry and popular among our game customers.
+- **Solutions are built for AWS**. This project is focused on improving the game development experience on AWS and does not try to standardize solutions for deployment across many hosting platforms. In our experience, doing so is generally difficult, unecessary, and fraught with tradeoffs. If AWS is not your jam, you're welcome to fork and customize as needed (see above)!
 
-    ---
+## Getting Started
 
-    Opinionated implementations to address common use cases for expedited game studio setup and battle-tested scenarios from the community.
+[Getting Started](./getting-started.md){ .md-button  }
 
-    [:octicons-arrow-right-24: Samples](./samples/index.html)
+## License
 
-</div>
+This project is licensed under the [MIT-0 License](https://github.com/aws-games/cloud-game-development-toolkit/blob/main/LICENSE).

docs/overrides/index.html

@@ -0,0 +1,48 @@
+{% extends "main.html" %}
+<!--  -->
+{% block hero %}
+<section class="hero-container">
+  <div class="md-grid md-typeset">
+    <div class="mdx-hero">
+      <div class="mdx-hero__image">
+        <img
+          src="{{ '/media/aws-games-background.jpeg' | url }}"
+          alt=""
+          width="50%"
+          draggable="false"
+        />
+      </div>
+      <div class="mdx-hero__content">
+        <h1>{{ page.meta.hero.title }}</h1>
+        <p>{{ page.meta.hero.subtitle }}</p>
+        <a
+          href="{{ '/getting-started' | url }}"
+          title="{{ page.next_page.title | e }}"
+          class="md-button md-button--primary"
+        >
+          {{ page.meta.hero.getting_started_button }}
+        </a>
+        <a
+          href="{{ '//github.com/aws-games/cloud-game-development-toolkit' | url }}"
+          title="Source code on GitHub"
+          class="md-button"
+          >{{ page.meta.hero.source_button }}
+        </a>
+      </div>
+    </div>
+  </div>
+</section>
+{% endblock %}
+<!-- Content -->
+{% block content %}
+<div class="mdx-features">
+  {% for feature in page.meta.features %}
+  <div>
+    <img src="{{ feature.image }}" />
+    <h2>{{ feature.title }}</h2>
+    <p>{{ feature.description }}</p>
+  </div>
+  {% endfor %}
+</div>
+{{ super() }}
+{% endblock %}

docs/overrides/main.html

@@ -2,7 +2,19 @@
 
 {% block outdated %}
   You're not viewing the latest version.
-  <a href="{{ '../' ~ base_url }}"> 
+  <a href="{{ '../' ~ base_url }}">
     <strong>Click here to go to latest.</strong>
   </a>
-{% endblock %}
+{% endblock %}
+
+<!-- Meta tags -->
+{% block extrahead %}
+
+<!-- Determine title -->
+{% set title = config.site_name %}
+<!-- prettier-ignore -->
+{% if page and page.title and not page.is_homepage %}
+{% set title = config.site_name ~ " - " ~ page.title | striptags %}
+{% endif %}
+
+{% endblock %}

docs/security.md

@@ -0,0 +1,6 @@
+---
+title: Security
+description: Security practices and processes for Cloud Game Development Toolkit
+---
+
+--8<-- "SECURITY.md"

docs/stylesheets/companies.css

@@ -0,0 +1,48 @@
+@keyframes slider {
+  0% {
+    transform: translateX(calc(100% - 100vw));
+  }
+  50% {
+    transform: translateX(0);
+  }
+  100% {
+    transform: translateX(calc(100% - 100vw));
+  }
+}
+
+.companies {
+  display: flex;
+  flex-direction: row-reverse;
+  white-space: nowrap;
+  overflow: hidden;
+  margin: 2rem auto;
+}
+
+.companies-title {
+  text-transform: uppercase;
+}
+
+.companies-slider {
+  white-space: nowrap;
+  animation: 150s linear infinite slider;
+}
+
+.companies .company {
+  height: 3rem;
+  opacity: 0.6;
+  margin: 0 1rem;
+  filter: grayscale() brightness(25%) invert(0);
+}
+
+.companies .company:hover {
+  opacity: 1;
+}
+
+[data-md-color-scheme="slate"] .companies .company {
+  filter: grayscale() brightness(25%) invert(1);
+}
+
+.companies .company img {
+  height: 100%;
+  max-height: 2.5em;
+}