From 5916d0711db83eef38051a3a5b5753be93e74262 Mon Sep 17 00:00:00 2001 From: Henry Kiem Date: Fri, 13 Feb 2026 15:51:50 -0800 Subject: [PATCH 1/2] refactor(docs): rename section index files to README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Rename documentation index files for consistency: - docs/assets/dockerfiles.md → docs/assets/docker/README.md - docs/assets/packer/index.md → docs/assets/packer/README.md - Update mkdocs.yml nav paths to match new locations --- docs/assets/{dockerfiles.md => docker/README.md} | 0 docs/assets/packer/{index.md => README.md} | 0 mkdocs.yml | 4 ++-- 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/assets/{dockerfiles.md => docker/README.md} (100%) rename docs/assets/packer/{index.md => README.md} (100%) diff --git a/docs/assets/dockerfiles.md b/docs/assets/docker/README.md similarity index 100% rename from docs/assets/dockerfiles.md rename to docs/assets/docker/README.md diff --git a/docs/assets/packer/index.md b/docs/assets/packer/README.md similarity index 100% rename from docs/assets/packer/index.md rename to docs/assets/packer/README.md diff --git a/mkdocs.yml b/mkdocs.yml index 92f85dac..d29f352c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -95,7 +95,7 @@ nav: - Assets: - Overview: docs/assets/index.md - Packer Templates: - - Overview: docs/assets/packer/index.md + - Overview: docs/assets/packer/README.md - Build Agents: - Linux Build Agents: - assets/packer/build-agents/linux/README.md @@ -105,7 +105,7 @@ nav: - Virtual Workstations: assets/packer/virtual-workstations/README.md - Jenkins Pipelines: assets/jenkins-pipelines/README.md - Ansible Playbooks: assets/ansible-playbooks/perforce/p4-server/README.md - - Dockerfiles: docs/assets/dockerfiles.md + - Dockerfiles: docs/assets/docker/README.md - Modules: - Overview: modules/README.md - Design Standards: modules/DESIGN_STANDARDS.md From b00e8959e99fcd84a9869672baffc2d8a9a47964 Mon Sep 17 00:00:00 2001 From: Henry Kiem Date: Fri, 13 Feb 2026 16:27:58 -0800 Subject: [PATCH 2/2] fix(docs): update internal links to match renamed files Update markdown links in docs/getting-started.md and docs/assets/index.md to reference the new file paths (packer/README.md, docker/README.md) instead of the old names (packer/index.md, dockerfiles.md). --- docs/assets/index.md | 4 ++-- docs/getting-started.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/assets/index.md b/docs/assets/index.md index 753f6068..82d04374 100644 --- a/docs/assets/index.md +++ b/docs/assets/index.md @@ -12,7 +12,7 @@ description: Re-usable assets for game development on AWS | Asset Type | Description | | :--------------------------------------------------------------- | :- | -| [:simple-packer: **Packer Templates**](./packer/index.md) | Packer templates provide an easy way to build machine images for commonly used game dev infrastructure. Currently the project includes Packer templates for UE5 build agents for Linux and Windows, as well as a Packer template for building a Perforce Helix Core version control AMI. | +| [:simple-packer: **Packer Templates**](./packer/README.md) | Packer templates provide an easy way to build machine images for commonly used game dev infrastructure. Currently the project includes Packer templates for UE5 build agents for Linux and Windows, as well as a Packer template for building a Perforce Helix Core version control AMI. | | [:simple-jenkins: **Jenkins Pipelines**](../../assets/jenkins-pipelines/README.md) | Jenkins Pipelines for common game dev automation workflows | | [:simple-ansible: **Ansible Playbooks**](../../assets/ansible-playbooks/perforce/p4-server/README.md) | Automation scripts for reusable system level configurations. Unlike Packer templates, you can use these to add new functionality to existing EC2 instances. | -| [:simple-docker: **Dockerfiles (Coming Soon!)**](./dockerfiles.md) | Dockerfiles for creating Docker images of commonly used game dev infrastructure. These are primarily used in scenarios where there aren't openly available pre-built images that address a use case, or significant customization is needed that warrants building an image | +| [:simple-docker: **Dockerfiles**](./docker/README.md) | Dockerfiles for creating Docker images of commonly used game dev infrastructure. These are primarily used in scenarios where there aren't openly available pre-built images that address a use case, or significant customization is needed that warrants building an image | diff --git a/docs/getting-started.md b/docs/getting-started.md index deecc5db..3ea842fb 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -8,7 +8,7 @@ Welcome to the **Cloud Game Development Toolkit ### Assets An _asset_ is a singular template, script, or automation document that may prove useful in isolation. Currently, the **Toolkit** contains three types of -_assets_: [Ansible playbooks](../assets/ansible-playbooks/perforce/p4-server/README.md), [Jenkins pipelines](../assets/jenkins-pipelines/README.md), and [Packer templates](../docs/assets/packer/index.md). Each of these +_assets_: [Ansible playbooks](../assets/ansible-playbooks/perforce/p4-server/README.md), [Jenkins pipelines](../assets/jenkins-pipelines/README.md), and [Packer templates](../docs/assets/packer/README.md). Each of these _assets_ can be used in isolation. For more information about _assets_, consult the [detailed documentation](../docs/assets/index.md).