Microsoft SQL Server 技术文档项目教程

1. 项目目录结构及介绍

Microsoft SQL Server 技术文档项目的目录结构如下：

sql-docs/
├── azure-sql/
├── data-migration/
├── docs/
│   ├── managed-reference/
│   │   └── sql2016/
│   │       └── xml/
├── media/
├── github/
│   └── workflows/
├── acrolinx-config.edn
├── gitattributes
├── gitignore
├── localization-config
├── openpublishing-build.ps1
├── openpublishing-publish-config.json
├── openpublishing-redirection-azure-data-studio.json
├── openpublishing-redirection-azure-sql.json
├── openpublishing-redirection.json
├── openpublishing-redirection-powershell.json
├── openpublishing-redirection-ssms.json
├── openpublishing-redirection-stretch-database.json
├── CONTRIBUTING.md
├── LICENSE
├── LICENSE-CODE
├── README.md
└── SECURITY.md

目录结构介绍

• azure-sql/: 包含与 Azure SQL 相关的文档。
• data-migration/: 包含数据迁移相关的文档。
• docs/: 主要文档目录，包含各种 SQL Server 的参考文档。
  • managed-reference/sql2016/xml/: 包含 SQL Server 2016 的 XML 参考文档。
• media/: 包含文档中使用的媒体文件（如图片）。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• acrolinx-config.edn: Acrolinx 配置文件，用于文档质量检查。
• gitattributes: Git 属性配置文件。
• gitignore: Git 忽略文件配置。
• localization-config: 本地化配置文件。
• openpublishing-build.ps1: 用于构建文档的 PowerShell 脚本。
• openpublishing-publish-config.json: 发布配置文件。
• openpublishing-redirection-*.json: 重定向配置文件，用于管理文档的 URL 重定向。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• LICENSE-CODE: 代码许可证。
• README.md: 项目介绍和使用说明。
• SECURITY.md: 安全指南。

2. 项目启动文件介绍

项目中没有明确的“启动文件”，因为该项目主要是文档集合，而不是一个可执行的应用程序。不过，以下文件在项目中起到关键作用：

• openpublishing-build.ps1: 这是一个 PowerShell 脚本，用于构建文档。在本地开发环境中，可以通过运行此脚本来生成文档。

3. 项目配置文件介绍

项目中有多个配置文件，以下是一些关键配置文件的介绍：

• openpublishing-publish-config.json: 此文件包含了文档发布的配置信息，如发布目标、发布路径等。
• openpublishing-redirection-*.json: 这些文件用于管理文档的 URL 重定向，确保旧的文档链接能够正确重定向到新的文档位置。
• acrolinx-config.edn: 此文件用于配置 Acrolinx 文档质量检查工具，确保文档符合质量标准。
• gitattributes: 此文件用于配置 Git 的属性，如文件的换行符处理、文件类型等。
• gitignore: 此文件用于配置 Git 忽略的文件和目录，避免将不必要的文件提交到版本库中。

这些配置文件共同确保了文档项目的构建、发布和质量检查过程的顺利进行。