awsdocs · ClarenceBai · Aug 1, 2025 · Aug 1, 2025 · Aug 1, 2025 · Aug 2, 2025
@@ -15,7 +15,18 @@ jobs:
       - name: Install Asciidoctor
         run: sudo apt-get install -y asciidoctor
 
-      - name: Run Vale
+      - name: Vale Style Check
+        uses: errata-ai/vale-action@reviewdog
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        with:
+          fail_on_error: false
+          reporter: github-pr-check
+          filter_mode: added
+          files: latest/ug
+        continue-on-error: true
+
+      - name: Enforce AWS Brand
         uses: errata-ai/vale-action@reviewdog
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
@@ -24,4 +35,5 @@ jobs:
           reporter: github-pr-check
           filter_mode: added
           files: latest/ug
-        continue-on-error: false
+          vale_flags: "--config brand.vale.ini"
+        continue-on-error: true
@@ -76,5 +76,7 @@ build
 *.xls
 *.xlsx
 *.xpr
+.idea/*
 vale/styles/AsciiDoc/
 vale/styles/RedHat/
+.amazonq/
@@ -12,5 +12,6 @@ BasedOnStyles = RedHat, AsciiDoc, EksDocs
 RedHat.GitLinks = OFF 
 AsciiDoc.UnsetAttributes = OFF 
 RedHat.CaseSensitiveTerms = suggestion
+RedHat.Contractions = OFF
 RedHat.TermsErrors = warning
 RedHat.Spacing = warning
@@ -68,7 +68,7 @@
             "----\n",
             "===="
         ],
-        "description": "adoc step tablist"
+        "description": "adoc step with tablist of console, eksctl, awscli, CFN"
     },
     "adoc region tablist": {
         "prefix": "tab-region",
@@ -152,16 +152,14 @@
     "NODE_ROOT Section": {
         "prefix": "adoc-topic",
         "body": [
-            "//!!NODE_ROOT <section>",
             "[.topic]",
             "[[${1:page-id},${1:page-id}.title]]",
             "= ${2:page title goes here}",
-            ":info_doctype: section",
             "",
             "include::../attributes.txt[]",
             "",
         ],
-        "description": "Creates a NODE_ROOT section template with topic class and ID"
+        "description": "Creates a section template with topic class and ID"
     },
     "Include with Leveloffset": {
         "prefix": "adoc-inc",
@@ -181,5 +179,15 @@
             "===="
         ],
         "description": "Creates a collapsible section in AsciiDoc"
+    },
+    "AsciiDoc Platform Version Table": {
+        "prefix": "adoc-pv",
+        "body": [
+            "| `${1:K8s version}`",
+            "| `eks.${2:platform version}`",
+            "| New platform version with security fixes and enhancements.",
+            "| ${3:Date available in all regions}"
+        ],
+        "description": "Creates entry in platform versions table"
     }
 }
@@ -1,32 +1,5 @@
 # default rule, unless a more specific rule applies
-* @eks-admins
-
-# lower approval for specific non-content folders
-/.vscode/ fincd@amazon.com
+* @awsdocs/eks-admins
 
 # default rule for user guide
-/latest/ug/ @eks-contributors
-
-# guide section assignments
-/latest/ug/clusters/ gcline@amazon.com
-/latest/ug/manage-access/ gcline@amazon.com
-/latest/ug/workloads/ gcline@amazon.com
-/latest/ug/networking/ fincd@amazon.com
-/latest/ug/storage/ pgasca@amazon.com
-/latest/ug/nodes/ pgasca@amazon.com
-/latest/ug/connector/ fincd@amazon.com
-/latest/ug/contribute/ gcline@amazon.com
-/latest/ug/getting-started/ mcngs@amazon.com
-/latest/ug/integrations/ gcline@amazon.com
-/latest/ug/observability/ pgasca@amazon.com
-/latest/ug/outposts/ fincd@amazon.com
-/latest/ug/security/ fincd@amazon.com
-/latest/ug/what-is/ mcngs@amazon.com
-
-# use default rule 
-# /latest/ug/troubleshooting/
-# /latest/ug/images/
-# /latest/ug/images_BJS/
-# /latest/ug/YAML
-# /latest/ug/iam_policies/
-# /latest/ug/diagrams/
+/latest/ug/ @awsdocs/eks-contributors
@@ -12,19 +12,19 @@ package.AmazonEKSDocs = {
     };
     scope = webservices;
 
-    build-system = happytrails;
+    build-system = zonbooktrails;
     build-environment = {
         chroot = basic;
         network-access = blocked;
     };
 
     build-tools = {
         3.0 = {
-            HappyTrails = 3.2;
+            ZonBookTrails = 1.0;
             AWSEC2ContainerChecklist = 1.0;
             AWSDevDocsQuotasShare = 1.0;
-            JavaBuildAndTestMin = jdk8;
-            ZonBook = 4.0;
+            AWSDocsSdkExamplesPublic = 1.0; 
+            ZonBook = 5.0;
             AWSDevDocsChecklistBJS = 2.0;
         };
     };

@@ -0,0 +1,14 @@
+# README-AUTOMATION.md
+This file includes details about generating automated content in this package.
+
+## GitHub Sync Script
+**RUN INSTRUCTIONS:** [Instructions for running the GitHub sync script (Quip/WorkDocs link)](https://quip-amazon.com/PL0vAsCa3p10/How-to-Run-the-GitHub-Sync-Script-AmazonEKSDocs)  
+
+**SCRIPT/CODE LOCATION:** [`sync-github.sh`](./sync-github.sh)  
+The script is located at the top level of this package.
+
+**DOC PAGES:** [Amazon EKS User Guide – GitHub Repository](https://github.com/awsdocs/amazon-eks-user-guide)  
+The script keeps the public GitHub repo (`awsdocs/amazon-eks-user-guide`) in sync with the internal GitFarm repository for the Amazon EKS User Guide. Unlike most other AWS documentation, the EKS User Guide is open source. For this reason, it is important to run the sync script **regularly (at least once or twice a week, if not more often)** to ensure contributions and changes remain aligned between the public and internal repositories.
+
+## Node repair tables
+The node repair tables are autogenerated using scripts run by the `eks-node-runtime` team. Any nececessary edits to the descriptions can be ported by employees to the source code.
@@ -2,15 +2,13 @@
 
 Welcome to the Amazon EKS User Guide repository. This repository contains the open source version of the [Amazon EKS User Guide](https://docs.aws.amazon.com/eks/latest/userguide/).
 
-## Important Update
+## New Contribution Experience 
 
-This repository will be temporarily taken down to prepare for a new contributor experience. The repository will return at the same url by mid-November. 
+You can now edit the EKS User Guide source directly. The AsciiDoc markup language meets the needs of the AWS Platform, while also being easy to learn. 
 
-## New Contribution Experience Coming Soon
+Use the "Edit this page on GitHub" links in the right sidebar of the EKS User Guide to submit changes. 
 
-We are temporarily taking down the current GitHub repository to prepare for an enhanced contribution experience. The new version will be available in mid-November with the following improvements:
-
-- **AsciiDoc-Powered Documentation**: The guide will use AsciiDoc, an intuitive yet powerful authoring language similar to Markdown that offers:
+- **AsciiDoc-Powered Documentation**: The docs now use AsciiDoc, an intuitive yet powerful authoring language similar to Markdown that offers:
   - Advanced formatting capabilities
   - Robust cross-referencing
   - Enhanced security controls
@@ -26,9 +24,7 @@ We are temporarily taking down the current GitHub repository to prepare for an e
 
 For more information about the new experience, see [Contribute](https://docs.aws.amazon.com/eks/latest/userguide/contribute.html) in the Amazon EKS User Guide.
 
-We look forward to your contributions when we launch the new GitHub experience. The improved platform will make it easier than ever to help us enhance the Amazon EKS documentation.
-
-
+We look forward to your contributions with the new GitHub experience. The improved platform makes it easier than ever to help us enhance the Amazon EKS documentation.
 
 ## License Summary
 

@@ -0,0 +1,14 @@
+StylesPath = vale/styles
+
+MinAlertLevel = error
+
+# Packages = RedHat, AsciiDoc
+
+#Vocab = EksDocsVocab
+
+# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
+[[!.]*.adoc]
+BasedOnStyles = EksDocs
+EksDocs.ExternalDomains = ON
+
+
@@ -1,6 +1,6 @@
-<?xml version="1.0"?>
-<project xmlns:ht="happytrails" name="AmazonEKSDocs-3.0" basedir="." default="build">
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:ht="happytrails" basedir="." default="build" name="AmazonEKSDocs-3.0">
  <description>This is the entry point for happy trails builds (package builder and eclipse).</description>
- <import file="${happytrails.root}/happytrails.xml"/>
+ <import file="${happytrails.root}/zonbooktrails.xml"/>
  <ht:import file="zfast/zonbook-4.5.xml"/>
 </project>