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

Document is out of date #189

Closed
Jiangbo-W opened this issue Jul 19, 2024 · 5 comments
Closed

Document is out of date #189

Jiangbo-W opened this issue Jul 19, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation Hacktoberfest OPEAHack

Comments

@Jiangbo-W
Copy link

  • The documentation need to be updated.

    1. The instruction of how to build and push container image is not correct with Makefile.
    2. Missing namespace in CLIENT_POD=$(kubectl get pod -l app=client-test -o jsonpath={.items..metadata.name})
  • There are too many ways(YAML files, HelmChart, GMC) to install OPEA and pipeline, which can make users feel confused. Is it possible to provide a single, unified installation method if they can be used interchangeably?

    If multiple methods need to be maintained, please describe the use cases for each method separately. This way, users can choose the installation method that suits them best.

  • At the same time, there are too many manifests under different components (GenAIInfra, GenAIExample), which result in high maintenance costs and inconsistencies.

  • Can the documentation describe how to deploy OPEA and pipeline that running behind a proxy.

@endomorphosis
Copy link

Can the documentation describe how to deploy OPEA and pipeline that running behind a proxy.

I did this recently, but I have so much work backlogged, and I am not an official OPEA maintainer, so I will defer this to someone else.

I dont think that there are too many different ways to setup OPEA, but it sounds like what you really think, is that there needs to be a CLI (or maybe LLM) to walk non technical users through their options.

@daisy-ycguo daisy-ycguo added the documentation Improvements or additions to documentation label Jul 25, 2024
@yongfengdu
Copy link
Collaborator

Already did cleanup of manifests, but we do need a document/summary for everything.

@KfreeZ
Copy link
Collaborator

KfreeZ commented Aug 22, 2024

GMC's doc is updated by #321 and #332

@yongfengdu
Copy link
Collaborator

One readme update here
opea-project/GenAIExamples#640

@xiguiw
Copy link

xiguiw commented Nov 8, 2024

Could we close this?

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 Hacktoberfest OPEAHack
Projects
None yet
Development

No branches or pull requests

7 participants