-
Notifications
You must be signed in to change notification settings - Fork 13
Docker Quick Start #18
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @Harry-Yu-Shuhang, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation by integrating Docker as a primary quick-start option and overhauling the Docker deployment guide. The changes aim to simplify the setup process for new users, particularly those unfamiliar with command-line Docker, by providing a comprehensive, step-by-step guide for Docker Desktop, alongside practical advice for common issues like network access in certain regions. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
您好,感谢您为改善 Docker 快速启动文档所做的贡献。新的面向初学者的 Docker Desktop 指南写得非常清晰易懂,这是一个很棒的改进。
我的反馈主要集中在 docs/user-guide/backend/docker.md 文件上。在重构文档以方便新用户的同时,一些对高级用户至关重要的信息(如命令行部署指令)以及所有用户都应了解的系统要求(如 GPU 支持、镜像大小)被意外移除了。我提供了一些具体的建议来补充这些缺失的内容,以确保文档的完整性,能够服务于所有不同技术水平的用户。
除此之外,还有一些小的拼写和格式建议,以提高文档的专业性。请查看具体的评论。谢谢!
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| # Docker 部署 | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/user-guide/backend/docker.md
Outdated
| - 首次启动时,Docker Desktop 会要求您登录 Docker Hub 账号。如果您没有账号,需要先注册一个。 | ||
|
|
||
| 5. 访问 `localhost:12393` 进行测试 | ||
| ## 使用终端命令 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/user-guide/backend/docker.md
Outdated
| :::danger | ||
| 由于重构幅度较大,Docker 镜像暂时还没有更新到 `v1.0.0` 版本,但是很快会更新。 | ||
| :::info 关于安装方式的说明 | ||
| 目前有两种安装方式,如果您是小白,推荐您[使用Docker DeskTop](#使用docker-desktop)。如果您对Docker比较熟悉,也可以[使用终端命令](#使用终端命令)。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/user-guide/backend/docker.md
Outdated
| :::warning | ||
| ⚠️ 请注意:此功能目前处于实验阶段,但在大多数情况下可以正常工作。 | ||
| :::note | ||
| 我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members),目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果docker镜像有问题,可以联系他(邮箱: [email protected])。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
为了与文档其他部分保持一致,建议将 docker hub 和 docker镜像 中的 docker 大写为 Docker,即 Docker Hub 和 Docker镜像。
| 我们在 docker hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members),目前docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果docker镜像有问题,可以联系他(邮箱: [email protected])。 | |
| 我们在 Docker Hub 成立了[openllmvtuber团队](https://hub.docker.com/orgs/openllmvtuber/members),目前Docker镜像由[@Harry_Y](https://github.com/Harry-Yu-Shuhang)维护。如果Docker镜像有问题,可以联系他(邮箱: [email protected])。 |
| @@ -1,56 +1,113 @@ | |||
| --- | |||
| sidebar_position: 8 | |||
| sidebar_position: 2 | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
我们有其他页面设置了 sidebar_position 2,所以如果一定要把 docker 放在第二个,其他文件的顺序也得改。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
那改一下?你觉得docker放2合适吗
Update Docker in quick start, which is the easiest way for beginners.