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

docs(karpor): refine helm installation document #598

Merged
merged 4 commits into from
Jan 27, 2025
Merged

Conversation

elliotxx
Copy link
Contributor

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

  • N
  • Y

2. What is the scope of this PR (e.g. component or file name):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

- Change section headers from '###' to '##' for better hierarchy
- Add detailed descriptions for AI backend options (OpenAI, Azure OpenAI, Hugging Face)
- Ensure consistency in parameter descriptions across both English and Chinese versions

These changes improve the readability and clarity of the installation guide, making it easier for users to understand the configuration options available for the AI backend.
- Translate all sections of the installation guide from English to Chinese
- Update table headers and descriptions to match the Chinese language
- Ensure consistency in terminology and formatting throughout the document
- Rephrase instructions for enabling AI features for clarity
- Add examples for different AI backends (OpenAI, Azure OpenAI, Hugging Face)
- Restructure configuration examples to improve readability

These changes aim to make the installation process for AI features more intuitive and provide better guidance for users configuring different AI backends.
Copy link

vercel bot commented Jan 27, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kusionstack ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 27, 2025 11:37am

- Change base URL from OpenAI to Deepseek
- Update model name from gpt-3.5-turbo to deepseek-chat

These changes reflect the switch from OpenAI to Deepseek as the AI backend service, ensuring the documentation is accurate and up-to-date.
Copy link
Contributor

@adohe adohe left a comment

Choose a reason for hiding this comment

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

/lgtm

@adohe adohe merged commit 3b03502 into main Jan 27, 2025
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants