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

Optimize document #641

Closed
gaius-qi opened this issue Sep 10, 2021 · 0 comments · Fixed by #673
Closed

Optimize document #641

gaius-qi opened this issue Sep 10, 2021 · 0 comments · Fixed by #673
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@gaius-qi
Copy link
Member

gaius-qi commented Sep 10, 2021

Feature request:

  • 文档目录整理
  • 完善 Quick Start,现在都是贴链接。Quick Start 要让用户能够快速开始整个项目。
  • docs/README.md 添加文档详细介绍,以及欢迎社区开发者共同完善文档,如何贡献文档链接到跟目录 CONTRIBUTING.md 文件。
  • docs/en/README.mddock/zh-CN/README.md 索引重新规整,现在问题比较多, 例如 kubernetes 部署相关放在生态里面等等。
    • 目录结构为:
      • 快速开始(以 helm-charts 来写参考 docs/en/ecosystem/Kubernetes-with-Dragonfly.md)
      • 架构
        • manager(用 docs/en/user-guide/console/preview.md)
        • sheduler(暂无 TODO)
        • cdn(暂无 TODO)
        • dfdaemon(暂无 TODO)
      • 部署
        • 部署方案(推荐使用 helm-charts)
          • kubernetes
            • helm-charts
            • kustomize
          • docker
            • docker-compose
            • 单独模块部署
              • manager
              • scheduler
              • cdn
              • dfdaemon
          • 二进制文件部署
            • 单独模块部署
              • manager
              • scheduler
              • cdn
              • dfdaemon
        • 配置文件
          • manager
          • scheduler
          • cdn
          • dfdaemon
      • 命令行(command)
        • manager(cli 相关)
        • scheduler(cli 相关)
        • cdn(cli 相关)
        • dfdaemon(cli 相关)
      • 运行时集成
        • containerd
        • cri-o
        • docker
      • 文件预热
        • console(暂无 TODO)
        • curl(用 docs/en/user-guide/preheat/preheat.md)
      • 项目开发(用户本地开发流程参考 docs/en/development/local.md)
      • 测试(参考 docs/en/test-guide/test-guide.md)
      • api(用 docs/en/api/api.md 文件内容)
  • 文档目录结构也按照上面的索引列表规整

Use case:

UI Example:

@gaius-qi gaius-qi added this to the v2.1.0 milestone Sep 10, 2021
@cndoit18 cndoit18 mentioned this issue Sep 23, 2021
11 tasks
@gaius-qi gaius-qi added the documentation Improvements or additions to documentation label Sep 27, 2021
e-ngo pushed a commit to e-ngo/dragonfly that referenced this issue Jan 23, 2025
feat: rename config.yaml for ci

Signed-off-by: Gaius <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants