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

feature: Document different AI backends #22

Closed
2 of 4 tasks
AnaisUrlichs opened this issue Apr 25, 2023 · 8 comments · Fixed by #40
Closed
2 of 4 tasks

feature: Document different AI backends #22

AnaisUrlichs opened this issue Apr 25, 2023 · 8 comments · Fixed by #40
Assignees

Comments

@AnaisUrlichs
Copy link
Member

Checklist:

  • I've searched for similar issues and couldn't find anything matching
  • I've discussed this feature in the #k8sgpt slack channel

Is this feature request related to a problem?

  • Yes
  • No

Description

It is now possible to use different AI backends e.g. k8sgpt-ai/k8sgpt#309
This is not yet reflected in the documentation

@rakshitgondwal
Copy link
Member

Hey, @AnaisUrlichs! I can work on this.

@AnaisUrlichs
Copy link
Member Author

Amazing, assigned the issue to you :)
Please document the different backends under a separate file in the reference/cli section https://github.com/k8sgpt-ai/docs/tree/main/docs/reference/cli

@rakshitgondwal
Copy link
Member

Amazing, assigned the issue to you :) Please document the different backends under a separate file in the reference/cli section https://github.com/k8sgpt-ai/docs/tree/main/docs/reference/cli

Sure! Can you also please refer to this comment once?

@AnaisUrlichs
Copy link
Member Author

Yes,

I was working on the documentation for the Azure AI backend, should I document NoOpAiProvider again?

Yes, please. Could you also please move the providers section from tutorials into reference?

the tutorials should showcase detailed, end-to-end tutorials from installation to getting results etc.
The providers section is more related to the docs, showing the different options.

@rakshitgondwal
Copy link
Member

Should I write about the backends in refrence/cli/backend.md or add a new providers folder like refrence/providers/. I am assuming that Backend and Provider are the same thing. @AnaisUrlichs

@rakshitgondwal
Copy link
Member

Hey @AnaisUrlichs, Can you please help me out here?

@AnaisUrlichs
Copy link
Member Author

ahhh sorry @rakshitgondwal -- Maybe a combination of both
reference/providers/backend.md
I the providers apply to both the Kubernetes operator and the CLI -- thus, I would not put them under CLI. However, one file "backend.md" should be enough for now as there should not be THAT much to tell about each provider.
In the future, If I don't reply, you can also ping me on the Slack or go ahead and start a "WIP" (work in progress) PR 🙂

@rakshitgondwal
Copy link
Member

ahhh sorry @rakshitgondwal -- Maybe a combination of both reference/providers/backend.md I the providers apply to both the Kubernetes operator and the CLI -- thus, I would not put them under CLI. However, one file "backend.md" should be enough for now as there should not be THAT much to tell about each provider. In the future, If I don't reply, you can also ping me on the Slack or go ahead and start a "WIP" (work in progress) PR slightly_smiling_face

Thank you for the reply! Will raise a PR soon.

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 a pull request may close this issue.

2 participants