Google Season of Docs 2023
感谢您有兴趣申请 conda-forge 的 Google Season of Docs。我们欢迎来自所有背景、身份和能力的人士提交申请，并鼓励技术领域弱势群体中的个人提交申请。
提案标题：重组 conda-forge 文档
关于 conda-forge
conda-forge 是一项社区工作和一个 GitHub 组织，其中包含 conda recipe 的存储库，从而为各种开源软件和工具提供 conda 软件包。这些软件的构建分发包上传到 anaconda.org/conda-forge，可以使用 conda、mamba 和其他工具安装。
2023 年是 conda-forge 组织成立 8 周年。在这 8 年中，它提供了超过 120 万个软件包工件，通过 anaconda.org 实现了 100 亿次下载。如果没有 4600 多名志愿者的工作，这一切都不可能实现！
conda-forge 如何工作？
conda-forge 是为 conda 打包生态系统构建和围绕其构建的。conda recipe 包含依赖项元数据和构建及打包特定项目（通常来自源代码）的说明。
新的 recipe 首先通过拉取请求 (PR) 提交到 conda-forge/staged-recipes 存储库。一旦经过审核和批准，recipe 将被合并并授予其自己的存储库，称为feedstock。feedstock 是 conda-forge 组织内的标准 GitHub 存储库，其中包含用户提供的 recipe 以及构建所需的支持配置和工具。
对于在 feedstock 中合并的每个 PR，都会为软件包构建一系列工件（诸如发布新版本或添加新依赖项之类的更改需要为整个生态系统的兼容性重建软件包）。对 feedstock 的所有贡献都通过 PR 进行。
conda-forge 如何组织？
conda-forge 组织由 核心团队 领导。核心团队还得到许多志愿者的支持，例如 staged-recipes 审核员或特定领域的 help-* 团队。任何人都可以通过拉取请求贡献 conda-forge 的 文档，这些拉取请求由 core 团队的至少一名成员审核和批准。
项目构想：重组 conda-forge 文档
问题
conda-forge.org 创建于大约 8 年前（conda-forge 项目成立之时）。8 年后，其文档通过 conda-forge 社区（用户、贡献者和核心团队）的许多成员的贡献而有机地增长。虽然这有助于保持一些文档的更新，但也增加了一些问题
- 目前，必须确切知道要查找什么才能找到其文档。因此，新手可能会发现导航和使用当前结构存在问题或令人困惑。
- 某些页面（例如知识库）增长过多且冗长。
- 某些部分之间存在明显的重叠。相同的想法可能会被单独讨论，只有部分一致和过时的信息，从而降低了文档的可用性。
- 通常很难知道新信息应该放在哪里，这使得进一步改进文档和引导新贡献者变得困难。
您的项目范围
本项目将
- 审核 conda-forge.org 中的现有内容，并借鉴 Diátaxis 框架的概念，提出内容的替代分类。
- 将现有内容迁移和调整为遵循 cf-infra-docs.netlify.app 中提出的重新组织。这将以迭代步骤完成，并侧重于更好地组织现有文档。
- 在迁移过程中，识别并实施技术文档的可访问性最佳实践（请参阅本文档末尾的参考文献）。
- 建议贡献工作流程，包括审核指南和新贡献需要遵守的关键方面的细目清单（例如，可访问性最佳实践、在哪里以及如何放置新内容项、样式指南）
- 识别缺失的内容，并提出一个大纲以填补现有空白。
本项目范围之外的工作
- 从头开始编写新的内容，即使被识别为缺失（例如，教程）
我们如何衡量成功？
- 将发布一份关于现有内容的报告，该报告讨论了其优缺点以及通过 Diátaxis 解决已发现问题的方案。
- 将制定一个迁移计划，将现有内容重组为以可维护性和可用性为先的结构。该计划将与社区共享，同时，我们将确保任何现有 URL 都可以转发，以避免当前用户感到困惑。
- 一旦获得批准，旧内容将迁移到 cf-infra-docs.netlify.app 的原型网站，并根据需要进行处理（以完成迁移计划）。
- 文档贡献指南将在审核过程中提供并执行。
- 关于文档的未解决 PR 和问题数量（截至 2023 年 3 月分别为 57 个和 61 个）在接下来的日历年中至少减少 50%。
时间表
| 日期 | 行动项 |
|---|---|
| 五月 | 聘请技术文档编写员 |
| 六月-七月 | 审核现有内容并提出 重组计划 |
| 八月-十月 | 迁移和调整内容，遵循 上述计划 |
| 十一月 | 建立文档贡献 指南和审核清单 |
项目预算
| 预算项目 | 金额 | 累计总额 | 备注 |
|---|---|---|---|
| 技术文档编写员 | 10,000.00 | 10,000.00 | |
| 总计 | 10,000.00 |
所需技能
必需
- 熟悉 Diátaxis 框架
- 精通英文写作
- 了解（理想情况下，有）编写包容性和可访问性文档或内容的经验
- 能够与来自不同背景的人合作
加分项
- 了解 Python、
conda和/或打包概念 - 之前为基于 Docusaurus 的网站（或使用静态 JS 框架和 Markdown 构建的网站）贡献过内容。
- 熟悉 Git、GitHub 和拉取请求驱动的工作流程
志愿者
- Jaime Rodríguez-Guerra (@jaimergp)：主要联系人
联系方式
有兴趣参与此项目的技术文档编写员应发送电子邮件至 [email protected]。请附上您的技术写作作品或作品集/简历/CV 的链接。
在发送申请之前，请随时通过 Element / Matrix (@jaimergp:matrix.org) 联系。
其他信息
conda-forge 也参与了 2023 年 Google Summer of Code。选定的 GSoC 候选人将负责为新的 conda-forge 网站创建样式指南，并在可访问性方面实施最佳实践。
Google Season of Docs 工作将负责为此工作提供内容对应部分。团队将共同为 conda-forge 社区提供一个全新的、现代的、可维护的、易于贡献的、可访问的网站。
附录
附加背景
当前的文档可以在基于 Sphinx 的 conda-forge.github.io` <[https://github.com/conda-forge/conda-forge.github.io](https://github.com/conda-forge/conda-forge.github.io)>\`_\_ 存储库中找到，一些博客文章来自 blog <[https://github.com/conda-forge/blog](https://github.com/conda-forge/blog)>\__。两者都使用 ReStructuredText 语法，并使用 Sphinx 构建。
一个新的基于 Docusaurus 的原型网站也可在 cf-infra-docs.netlify.app 上找到，新文档正在为 conda-forge 基础设施编写。其想法是将此原型站点用作新内容组织想法和实验的试验场。该站点使用 Markdown 语法。
我们将以纯 Markdown 格式编写内容，这两种引擎都支持。