EKS Workshop 项目教程

1. 项目目录结构及介绍

EKS Workshop 项目的目录结构如下：

eks-workshop/
├── archetypes/
├── content/
├── layouts/
├── static/
├── themes/
├── .gitignore
├── .gitmodules
├── .gitpod.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── amplify.yml
├── amplify.yml.readme
├── buildspec.yml.disabled
├── codebuild-deploy.sh
├── config.toml
├── package-lock.json
└── package.json

目录介绍：

• archetypes/：包含项目的基本模板文件。
• content/：存放项目的实际内容文件，通常是 Markdown 文件。
• layouts/：包含项目的布局文件，定义了页面的结构。
• static/：存放静态资源文件，如图片、CSS 和 JavaScript 文件。
• themes/：包含项目的主题文件，定义了项目的外观和风格。
• .gitignore：指定 Git 版本控制系统忽略的文件和目录。
• .gitmodules：定义了 Git 子模块的配置。
• .gitpod.yml：GitPod 的配置文件，用于自动化开发环境设置。
• CODE_OF_CONDUCT.md：项目的代码行为准则。
• CONTRIBUTING.md：项目的贡献指南。
• LICENSE：项目的开源许可证文件。
• README.md：项目的自述文件，包含项目的基本信息和使用说明。
• amplify.yml：AWS Amplify 的配置文件。
• amplify.yml.readme：Amplify 配置文件的说明文档。
• buildspec.yml.disabled：构建规范文件，通常用于 CI/CD 流程。
• codebuild-deploy.sh：用于部署的 Shell 脚本。
• config.toml：项目的配置文件，包含项目的全局设置。
• package-lock.json：锁定项目依赖版本的文件。
• package.json：项目的 npm 配置文件，包含项目的依赖和脚本。

2. 项目的启动文件介绍

EKS Workshop 项目的启动文件主要是 package.json 中的脚本部分。以下是一些关键的启动脚本：

{
  "scripts": {
    "start": "npx hugo server",
    "build": "npx hugo",
    "test": "npx hugo --buildDrafts"
  }
}

启动脚本介绍：

• npm start：启动本地开发服务器，用于实时预览项目。
• npm run build：构建项目，生成静态文件。
• npm run test：构建项目并包含草稿文件，用于测试。

3. 项目的配置文件介绍

EKS Workshop 项目的主要配置文件是 config.toml，它包含了项目的全局配置。以下是一些关键配置项的示例：

baseURL = "https://eksworkshop.com/"
languageCode = "en-us"
title = "EKS Workshop"
theme = "eks-workshop-theme"

[params]
  description = "AWS Workshop for Learning EKS"
  author = "AWS"

配置项介绍：

• baseURL：项目的根 URL。
• languageCode：项目的语言代码。
• title：项目的标题。
• theme：项目使用的主题名称。
• params：包含项目的其他参数，如描述和作者信息。

通过这些配置文件和脚本，开发者可以轻松地启动、构建和配置 EKS Workshop 项目。