docs

其他

github/docs

GitHub 文档的开源仓库,允许社区贡献。

项目简介

该仓库托管 GitHub 官方文档的源内容。它采用开源方式,允许 GitHub 员工和外部贡献者共同改进文档。内容涵盖使用 GitHub 产品和功能的指南、参考和教程。

README 预览

# GitHub Docs \n\nWelcome to GitHub Docs! GitHub’s documentation is open source, meaning anyone from inside or outside the company can contribute. For full contributing guidelines, visit our [contributing guide](https://docs.github.com/en/contributing).\n\n\n## Quick links by contributor type\n\n* **Hubbers (GitHub employees):** See [CONTRIBUTING.md](https://github.com/github/docs-content/blob/main/CONTRIBUTING.md) in the `docs-content` repository for GitHub-specific processes.\n\n* **Open source contributors:** See [CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) in the `docs` repository for a quick-start summary.\n\n## How we sync changes across Docs repositories\n\nThere are two GitHub Docs repositories: \n\n- **`github/docs`** (public): Open to external contributions\n\n- **`github/docs-internal`** (private): For GitHub employee contributions. \n\nThe two repositories sync frequently. Content changes in one are reflected in the other.  Hubbers might prefer to post in `docs` when working with a customer, but `docs` has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to `docs-internal`.\n\n**Important:** The `docs` repository accepts contributions to content files (`.md` files in `/content` and select `/data` sections like reusables only). Infrastructure files, workflows, and site-building code are not open for external modification.\n\n## New to contributing\n\nHere are some resources to help you get started with open source contributions:\n\n* [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)\n* [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)\n* [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)\n* [Collaborating with pull requests](https://docs.github.com/en/github

常见问题 (2)

故障排除
我可以提交 pull request 来修复已翻译的 GitHub Docs 页面吗?

不可以。GitHub Docs 不接受针对翻译文件(如德语、日语、西班牙语)的社区 Pull Request,因为翻译是通过内部自动化本地化系统管理的。如果您发现翻译错误或想提出措辞改进建议,请在 github/docs 仓库中提交一个 Issue 描述该问题——文档团队会对其进行标记,并转发给内部本地化团队进行修正。

来源 Issue #46364
how_to
如何配置 GitHub Actions Runner Controller (ARC),使其在个人帐户上使用 GitHub App 进行身份验证?

这是受支持的;GitHub App 不需要由组织拥有或安装。在 https://github.com/settings/apps/APP_SLUG 处您的个人帐户下创建或打开该应用,将其安装到您的个人帐户上,并复制安装 ID——即安装设置页面上显示的数字 ID。使用与组织相同的 GitHub App 设置来配置 ARC:github_app_id、github_app_installation_id 和 github_app_private_key。对于组织拥有的应用,相应的设置 URL 为 https://github.com/organizations/ORG/settings/apps/APP_SLUG;ARC 本身对这两种安装类型的处理方式相同。该文档限制已在 PR #46167 中得到更正。

来源 Issue #46166