Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ChaosBlade官网完善] 优化完善ChaosBlade官网 #758

Open
9 of 17 tasks
MandssS opened this issue Jul 15, 2022 · 1 comment
Open
9 of 17 tasks

[ChaosBlade官网完善] 优化完善ChaosBlade官网 #758

MandssS opened this issue Jul 15, 2022 · 1 comment
Labels
chaosblade-website chaosblade-website project community priority/high Very important, need to be worked with soon but not very urgent type/feature Category issues or prs related to feature request.

Comments

@MandssS
Copy link
Contributor

MandssS commented Jul 15, 2022

大家好,

该issue为ChaosBlade官网优化完善。 chaosblade.io是我们目前的官方网站,由开源项目chaosblade-website持续交付。

现在官网只有简单的样式、设计和简略的文档。我们需要对其进行改进和优化。我们需要您的参与!只要你了解

ChaosBlade,UI 设计,Web前端技术。

欢迎加入我们!

根据我们的贡献者阶梯,您可以根据贡献程度获得我们社区相应的荣誉和治理权。

目前官网的待办事项如下:

  • 首页 UI、排版、设计、css样式优化
  • 入门页面 补充
    • 添加社区开始文档(社区会议、贡献者阶梯等)
    • 完善快速开始文档(目前仅通过动图展示了chaosblade的docker命令的一键安装和使用,需要更详细的安装和操作指导文件。)
      • Box部署、探针安装、运行实验、探针卸载等。
      • 命名空间、状态监控等其他功能文档。
    • 引用或添加 ChaosBlade 命令文档,参考 https://chaosblade-io.gitbook.io/chaosblade-help-zh-cn/
    • 功能特性和架构设计需要作为单独的页面进行补充和改进(之前统一在Get-Started/introduce页面)
  • 将社区添加到导航栏并添加相关页面
    • 贡献者相关文档
      • 贡献者指南概述(CNCF Coc、代码规范、开发环境设置、PR 提交指南)
      • 开发规范
      • 开发环境指南
      • PR提交指南
      • 问题提交和处理规范
      • 官方文档贡献指南
    • 团队致谢文件
      • 采用公司和团队的展示、致谢和登记入口
      • 社区成员、审阅者、维护者致谢
    • 社区资源汇总
      • 会议链接、会议回放
  • 增加贡献博客入口

待办事项清单:

  1. 首页
  • - 主页 UI、排版、设计和 css 样式优化
  • - 版本化文档
  1. 入门页面
  • - 添加社区启动文档
  • - 添加box部署、probe安装、运行实验、probe卸载等文档
  • - 命名空间、状态监控等功能文档
  • - 引用或添加 ChaosBlade 命令文档,参考 https://chaosblade-io.gitbook.io/chaosblade-help-zh-cn/
  • - 功能特性和架构设计文档
  1. 社区导航栏
  • - 添加贡献者指南概述文档
  • - 添加开发规范文档
  • - 添加开发环境指南文档
  • - 添加 PR 提交指南文件
  • - 问题提交和处理规范文件
  • - 添加官方文档贡献指南文档
  • - 添加采用公司和团队的演示文稿、致谢和注册门户文档。
  • - 添加社区成员、审阅者、维护者致谢文件
  • - 添加社区资源摘要文档
  1. 博客
  • - 添加贡献博客入口
@sunny0826
Copy link
Contributor

版本化文档已经在 https://chaosblade.io 上线,如有相关问题,请在新建 issue 或在本 issue 进行反馈

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chaosblade-website chaosblade-website project community priority/high Very important, need to be worked with soon but not very urgent type/feature Category issues or prs related to feature request.
Projects
None yet
Development

No branches or pull requests

2 participants