Azure .NET SDK 文档项目结构与配置指南

Azure .NET SDK 文档项目结构与配置指南

azure-docs-sdk-dotnet Repository for documentation on the Azure .NET SDK. 项目地址: https://gitcode.com/gh_mirrors/az/azure-docs-sdk-dotnet

1. 项目目录结构及介绍

Azure .NET SDK 文档项目采用以下目录结构组织文件：

• .github/：包含与 GitHub 相关的配置文件，例如代码拥有者（CODEOWNERS）和用于文档作者的扩展配置。
• .vscode/：包含 Visual Studio Code 的配置文件，推荐插件和设置。
• /add/：包含可能用于添加新内容的目录和文件。
• /api/overview/azure/：存放 Azure SDK API 的概览文档。
• /docs-ref-conceptual/：包含概念性文档，如教程、指南和参考。
• /docs-ref-overwrite/：用于覆盖默认文档内容的目录。
• /docsms-allowlist/：包含允许列表的目录，用于文档生成。
• /includes/：包含可重用的文档片段。
• /media/：存放与文档相关的媒体文件，如图片和视频。
• /metadata/：包含文档元数据的文件。
• /xml/：包含与 XML 相关的文件，可能用于文档生成。
• .gitignore：指定 Git 忽略的文件和目录。
• .localization-config：本地化配置文件，用于文档的国际化。
• .openpublishing.publish.config.json：发布配置文件，用于定义发布过程。
• .openpublishing.redirection.json：重定向配置文件，用于处理文档的重定向。
• LICENSE 和 LICENSE-CODE：包含项目的许可信息。
• README.md：项目自述文件，介绍项目的基本信息。
• SECURITY.md：安全策略文件，描述项目安全相关的指南。
• ThirdPartyNotices：第三方通知文件，列出项目使用的第三方组件。
• docfx.json：文档生成工具 DocFX 的配置文件。
• index.md：项目的首页文档。
• missing_apis.yml：记录缺失 API 的文件。
• update-toc.py：更新目录结构的 Python 脚本。

2. 项目的启动文件介绍

对于文档项目，启动文件通常是用于生成和查看文档的工具配置文件。在这个项目中，docfx.json 是主要的启动文件。它用于配置 DocFX 文档生成工具，定义文档的源文件、输出目录以及其他生成选项。

{
  "metadata": [...],
  "build": {
    "content": [...],
    "dest": "output",
    "disableGitFeatures": true
  },
  "serve": {
    "port": 8080,
    "path": "/",
    "disableGitFeatures": true
  }
}

index.md 也是重要的启动文件，它是文档的入口页面，通常包含项目的概述和快速入门指南。

# Azure .NET SDK 文档

本文档提供了 Azure .NET SDK 的详细说明和使用指南。

3. 项目的配置文件介绍

配置文件用于定义项目的行为和外观。以下是一些关键配置文件及其用途：

• .openpublishing.publish.config.json：定义文档发布过程的配置，包括发布到的位置、发布选项等。

{
  "publishing": {
    "metadata": [...],
    "versions": [...],
    "layout": "public",
    "cdnEnabled": true
  }
}

• .openpublishing.redirection.json：用于配置文档中的重定向规则，确保旧链接可以自动跳转到新位置。

{
  "redirections": [
    {
      "oldPath": "/old/path",
      "newPath": "/new/path"
    }
  ]
}

• .gitignore：定义 Git 忽略的文件和目录，以避免将不必要的文件提交到版本控制。

# Ignore build output
output/

# Ignore IDE and editor settings
.vscode/

通过了解这些目录结构和配置文件，您可以更好地启动和管理 Azure .NET SDK 的文档项目。

azure-docs-sdk-dotnet Repository for documentation on the Azure .NET SDK. 项目地址: https://gitcode.com/gh_mirrors/az/azure-docs-sdk-dotnet