github/github-well-architected
GitHub: github/github-well-architected
GitHub 官方维护的 Well-Architected Framework 知识库与静态网站,为大规模采用 GitHub 平台的团队提供涵盖生产力、协作、安全、治理和架构五大支柱的最佳实践指导。
Stars: 39 | Forks: 5
[](https://github.com/github/github-well-architected/actions/workflows/pr-check.yml)
[](https://github.com/github/github-well-architected/actions/workflows/deploy-merged-pr.yml)
[](https://github.com/github/github-well-architected/actions/workflows/github-code-scanning/codeql)

## 欢迎
此仓库维护着 [GitHub Well-Architected Framework](https://wellarchitected.github.com) 及其内容库的静态网站。该网站提供具有指导性、由社区驱动的建议,以帮助您有效地采用和部署 GitHub 平台。
**快捷链接:**
- 🌐 [查看网站](https://wellarchitected.github.com)
- 💬 [社区讨论](https://github.com/orgs/community/discussions?discussions_q=label%3A%22GitHub+Well-Architected%22)
- 🤝 [合作伙伴讨论](https://github.com/githubpartners-community/community/discussions/categories/waf-feedback-and-suggestions)
- 📖 [贡献指南](CONTRIBUTING.md)
[🎬 观看预告片](https://github.com/user-attachments/assets/51fc5744-a61b-4119-8892-bd93b1c26fe8)
## 快速开始
只需三个步骤,即可开始为 GitHub Well-Architected Framework 做出贡献:
### 1. 从 GitHub Codespaces 开始
[](https://codespaces.new/github/github-well-architected)
### 2. 创建新文章
选择一个支柱:`productivity`、`collaboration`、`application-security`、`governance` 或 `architecture`
```
hugo new content library/{PILLAR}/recommendations/{ARTICLE-NAME}.md
```
### 3. 查看网站
```
tools/server
```
在 Codespaces 中出现提示时打开该网站。
## 文档
有关该框架的公开信息,请参阅 [docs/README](docs/README.md) 及其目录:
- **[框架概述](docs/framework-overview.md)**:使命、愿景、目标、支柱和设计原则
- **[分类体系](docs/taxonomies.md)**:内容库文章分类的完整参考
## 开发说明
我们建议使用 GitHub Codespaces 以获得无缝的贡献体验。如果您更倾向于在本地搭建环境,请按照以下说明操作。
### 前置条件
在本地运行此项目之前,您需要:
- [Node.js](https://nodejs.org/en/download/)
- [npm](https://www.npmjs.com/get-npm)(随 Node.js 一起提供)
- [Hugo](https://gohugo.io/getting-started/installing/)
### 设置
克隆此仓库(如果使用 HTTPS):
```
git clone https://github.com/github/github-well-architected.git
```
初始化您的工作区:
```
tools/setup
```
### 本地运行
要在本地运行网站,请使用以下命令:
```
export SITE_URL=http://localhost:1313/
tools/server
```
此脚本会启动 Hugo 开发服务器,并自动在您的默认浏览器中通过 `http://localhost:1313/` 打开网站。
- 服务器会监视文件更改并自动重新加载网站。
- 如果您需要指定其他端口,请在运行脚本前设置 `PORT` 环境变量:
PORT=8080 tools/server
- 如需故障排查,请检查终端输出以获取错误或日志。
### 测试
为测试设置网站 URL:
```
export SITE_URL=http://localhost:1313/
```
运行所有测试:
```
tools/test
```
仅运行功能测试:
```
tools/test --functional
```
运行 linter:
```
tools/lint
```
检查测试输出是否有错误,并在提交更改前解决所有失败项。
有关更详细的开发说明(包括 GitHub Codespaces 设置),请参阅[贡献指南](CONTRIBUTING.md)。
## 许可证
本项目基于 MIT 开源许可证的条款授权。完整条款请参阅 [LICENSE](./LICENSE) 文件。
## 特别感谢
感谢这些[出色的贡献者](docs/contributors.md),以及 Issues 和 Discussions 中的作者们,感谢他们为 GitHub Well-Architected Framework 取得成功所做出的贡献。

标签:MITM代理, 暗色界面, 最佳实践, 架构框架, 研发效能, 自动化攻击, 防御加固, 静态网站