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

Update ChatQnA README.md #762

Closed
wants to merge 2 commits into from
Closed

Conversation

xiguiw
Copy link
Collaborator

@xiguiw xiguiw commented Sep 6, 2024

Add pull docker images from docker hub

Description

The summary of the proposed changes as long as the relevant motivation and context.

Issues

#412

Type of change

Document update

  • Others (enhancement, documentation, validation, etc.)

Dependencies

No

Tests

Verified pull down docker images works as expected.

Add pull docker images from docker hub

Signed-off-by: Wang, Xigui <[email protected]>
@@ -57,6 +57,34 @@ chaqna-xeon-ui-server
Port 5173 - Open to 0.0.0.0/0
```

You can pull ChatQnA and components docker images form docker hub or build images from source code.

## 🚀 Pull docker images
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to pull the image manually, when you run docker compose, the image will be pull automatically.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, there is no need to pull the Docker images explicitly at all.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hold on this change as some images are behind in terms of approval

Copy link
Contributor

@arun-gupta arun-gupta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The flow of instructions can be further simplified.

@@ -57,6 +57,34 @@ chaqna-xeon-ui-server
Port 5173 - Open to 0.0.0.0/0
```

You can pull ChatQnA and components docker images form docker hub or build images from source code.

## 🚀 Pull docker images
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, there is no need to pull the Docker images explicitly at all.

```

Go to [Section Check Docker Images)](#Check-Docker-Images)

## 🚀 Build Docker Images
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section should be moved to a backup section. Keep the flow simple for developer to get started.

@xiguiw xiguiw closed this Oct 11, 2024
@xiguiw xiguiw deleted the chatqna-doc branch October 11, 2024 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants