docs: update documentation

.gitignore

@@ -13,8 +13,8 @@ crash.log
 crash.*.log
 
 # Exclude all .tfvars files, which are likely to contain sensitive data, such as
-# password, private keys, and other secrets. These should not be part of version 
-# control as they are data points which are potentially sensitive and subject 
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
 # to change depending on the environment.
 *.tfvars
 !example.tfvars
@@ -44,6 +44,7 @@ terraform.rc
 
 # Ignore IDE configurations
 .idea
+*.vscode
 
 # Ignore pre-check cache
 .pre-commit-trivy-cache/*

.pre-commit-config.yaml

@@ -9,6 +9,8 @@ repos:
       - id: check-merge-conflict
       - id: detect-private-key
       - id: detect-aws-credentials
+        args:
+          - --allow-missing-credentials
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/bridgecrewio/checkov

docs/modules/jenkins/terraform-docs.md

@@ -0,0 +1,2 @@
+# Terraform Module Docs
+--8<-- "modules/jenkins/README.md"

docs/modules/perforce/helix-authentication-service/helix-authentication-service.md

@@ -0,0 +1,9 @@
+# Helix Authentication Service (HAS)
+
+[Jump to Terraform docs](./terraform-docs.md){ .md-button .md-button--primary }
+
+[Perforce Helix Authentication Service](https://www.perforce.com/downloads/helix-authentication-service) enables you to integrate certain Perforce products with your organization's Identity Provider (IdP).
+
+This module deploys Perforce Helix Authentication Service on AWS as a fully managed ECS Service using Fargate.
+
+Add details here

docs/modules/perforce/helix-authentication-service.md → docs/modules/perforce/helix-authentication-service/terraform-docs.md

@@ -1 +1,2 @@
---8<-- "modules/perforce/helix-authentication-service/README.md"
+# Terraform Module Docs
+--8<-- "modules/perforce/helix-authentication-service/README.md"

docs/modules/perforce/helix-core/helix-core.md

@@ -0,0 +1,9 @@
+# Perforce Helix Core
+
+[Jump to Terraform docs](./terraform-docs.md){ .md-button .md-button--primary }
+
+[Perforce Helix Core](https://www.perforce.com/products/helix-core/aws) is a scalable version control system that helps teams manage code alongside large, digital assets and collaborate more effectively in one central, secure location. With AWS, teams can quickly deploy Helix Core and accelerate innovation.
+
+This module deploys Perforce Helix Core on AWS using an Amazon Machine Image (AMI) that is included in the Cloud Game Development Toolkit. You can provision this AMI using [Hashicorp Packer](https://www.packer.io/). To get started, navigate to `/assets/packer/perforce/helix-core` and consult the documentation.
+
+Add details here

docs/modules/perforce/helix-core/terraform-docs.md

@@ -0,0 +1,2 @@
+# Helix Core - Terraform Module Docs
+--8<-- "modules/perforce/helix-core/README.md"

docs/modules/perforce/helix-swarm/helix-swarm.md

@@ -0,0 +1,7 @@
+# Perforce Helix Swarm
+
+[Jump to Terraform docs](./terraform-docs.md){ .md-button .md-button--primary }
+
+[Perforce Helix Swarm](https://www.perforce.com/products/helix-swarm) is a free code review tool for projects hosted in [Perforce Helix Core](https://www.perforce.com/products/helix-core).
+
+Insert module usage and instructions here.

docs/modules/perforce/helix-swarm/terraform-docs.md

@@ -0,0 +1,2 @@
+# Terraform Module Docs
+--8<-- "modules/perforce/helix-swarm/README.md"

docs/requirements.txt

@@ -3,3 +3,4 @@ mkdocs-material==9.5.30
 mkdocs-material-extensions==1.3.1
 mike==2.1.2
 mkdocs-git-revision-date-plugin==0.3.2
+mkdocs-open-in-new-tab==1.0.3

mkdocs.yml

@@ -31,7 +31,7 @@ theme:
       toggle:
         icon: material/lightbulb-outline
         name: Switch to light mode
-  
+
   features:
     - toc:
         permalink: true
@@ -77,24 +77,32 @@ markdown_extensions:
       emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.tabbed:
       alternate_style: true
-      
+
 nav:
-  - Home: 
+  - Home:
       - Home: index.md
-      - Assets: 
+      - Assets:
           - Overview: assets/index.md
           - Packer Templates: assets/packer.md
           - Jenkins Pipelines: assets/jenkins-pipelines.md
           - Ansible Playbooks: assets/playbooks.md
           - Dockerfiles: assets/dockerfiles.md
-      - Modules: 
+      - Modules:
           - Overview: modules/index.md
-          - Jenkins: modules/jenkins/index.md
+          - Jenkins:
+              - Installation and Usage: modules/jenkins/jenkins.md
+              - Module Docs: modules/jenkins/terraform-docs.md
           - Perforce:
-              - Helix Authentication Service: modules/perforce/helix-authentication-service.md
-              - Helix Core Server: modules/perforce/helix-core.md
-              - Helix Swarm: modules/perforce/helix-swarm.md
-      - Samples: 
+              - Helix Authentication Service:
+                  - Installation and Usage: modules/perforce/helix-authentication-service/helix-authentication-service.md
+                  - Module Docs: modules/perforce/helix-authentication-service/terraform-docs.md
+              - Helix Core Server:
+                  - Installation and Usage: modules/perforce/helix-core/helix-core.md
+                  - Module Docs: modules/perforce/helix-core/terraform-docs.md
+              - Helix Swarm:
+                  - Installation and Usage: modules/perforce/helix-swarm/helix-swarm.md
+                  - Module Docs: modules/perforce/helix-swarm/terraform-docs.md
+      - Samples:
           - Overview: samples/index.md
           - Simple Build Pipeline: samples/simple-build-pipeline.md
       - Changelog: changelog.md
@@ -103,11 +111,13 @@ nav:
   - Contributing: contributing.md
   - Discussion: discussion.md
   - CI: ci/
+  - Roadmap: https://github.com/orgs/aws-games/projects/1/views/1
 
 plugins:
   - search
   - git-revision-date
   - offline
+  - open-in-new-tab
 
 extra:
   version:
@@ -117,4 +127,4 @@ extra:
 extra_css:
   - stylesheets/extra.css
 
-copyright: Copyright © 2024 Amazon Web Services
+copyright: Copyright © 2024 Amazon Web Services