Improve the steps for running docker compose in the setup documentation #4462
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #4462 +/- ##
=======================================
Coverage 68.43% 68.43%
=======================================
Files 72 72
Lines 3516 3516
Branches 560 560
=======================================
Hits 2406 2406
Misses 924 924
Partials 186 186 ☔ View full report in Codecov by Sentry. |
k-boikov
approved these changes
May 29, 2023
bfalans
reviewed
May 31, 2023
| @@ -34,13 +34,13 @@ Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](htt | |||
| ### Set up with Docker | |||
|
|
|||
| 1. Make sure you have Docker installed, see [requirements](#requirements) | |||
| 2. Pull the latest image from [Docker Hub] | |||
| 2. Create a project directory for Auto-GPT | |||
|
|
|||
| :::shell | |||
There was a problem hiding this comment.
":::shell", should this be visible here? codeblock marker can be mistaken for code
|
|
||
| 3. Create a folder for Auto-GPT | ||
| 4. In the folder, create a file called `docker-compose.yml` with the following contents: | ||
| 3. In the project directory, create a file called `docker-compose.yml` with the following contents: | ||
|
|
||
| :::yaml |
There was a problem hiding this comment.
":::yaml" this should not be added to the file contents. When opening setup.md from folder this seems part of the code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
I'm trying to make the instructions in the setup doc more easy-to-follow. Users are confused with the current steps, e.g. whether to create the folder in the docker container or in the project folder. There's a recent question/feedback from a user in tech support channel.
https://discord.com/channels/1092243196446249134/1098744126461198447/1103984881526116432
Changes
Reordered the steps for docker compose so that it's more intuitive to follow. To avoid confusion, we should instruct users to complete the project directory creation and add relevant files in the folder first, before pulling the docker image and running docker compose.
PR Quality Checklist