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

feat(karpor): freeze karpor v0.6 documentation #586

Merged
merged 6 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,15 @@ npm run docusaurus docs:version:karpor v0.4
npm run write-translations -- --locale zh --override
```

Use karpor as an example, when preparing to officially release version v0.6.0, execute the following commands in sequence:
```bash
npm run docusaurus docs:version:karpor v0.6
npm run write-translations -- --locale zh --override && npm run write-translations -- --locale en --override
# Note: After execution, version declaration files will be automatically updated.
# For example, the next version in current.json will be changed to v0.7.0.
# And, you need to remove any file changes unrelated to Karpor here.
```

Optional sub product names:

- `docs` (alias for kusion)
Expand Down
7 changes: 6 additions & 1 deletion docs/karpor/1-getting-started/2-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,16 +98,21 @@ If you are trying to install Karpor with AI features, including natural language
helm install karpor-release kusionstack/karpor \
--set server.ai.authToken=YOUR_AI_TOKEN \
--set server.ai.baseUrl=https://api.openai.com/v1
# server.ai.backend has default values `openai`, which can be overridden when necessary. If the backend you are using is compatible with OpenAI, then there is no need to make any changes here.

# server.ai.backend has default values `openai`, which can be overridden when necessary.
# If the backend you are using is compatible with OpenAI, then there is no need to make
# any changes here.
helm install karpor-release kusionstack/karpor \
--set server.ai.authToken=YOUR_AI_TOKEN \
--set server.ai.baseUrl=https://api.openai.com/v1 \
--set server.ai.backend=huggingface

# server.ai.model has default values `gpt-3.5-turbo`, which can be overridden when necessary.
helm install karpor-release kusionstack/karpor \
--set server.ai.authToken=YOUR_AI_TOKEN \
--set server.ai.baseUrl=https://api.openai.com/v1 \
--set server.ai.model=gpt-4o

# server.ai.topP and server.ai.temperature can also be manually modified.
helm install karpor-release kusionstack/karpor \
--set server.ai.authToken=YOUR_AI_TOKEN \
Expand Down
2 changes: 1 addition & 1 deletion i18n/en/docusaurus-plugin-content-docs-karpor/current.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version.label": {
"message": "v0.6 🚧",
"message": "v0.7 🚧",
"description": "The label for version current"
},
"sidebar.karpor.category.Getting Started": {
Expand Down
46 changes: 46 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs-karpor/version-v0.6.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"version.label": {
"message": "v0.6",
"description": "The label for version v0.6"
},
"sidebar.karpor.category.Getting Started": {
"message": "Getting Started",
"description": "The label for category Getting Started in sidebar karpor"
},
"sidebar.karpor.category.Concepts": {
"message": "Concepts",
"description": "The label for category Concepts in sidebar karpor"
},
"sidebar.karpor.category.User Guide": {
"message": "User Guide",
"description": "The label for category User Guide in sidebar karpor"
},
"sidebar.karpor.category.How to Insight": {
"message": "How to Insight",
"description": "The label for category How to Insight in sidebar karpor"
},
"sidebar.karpor.category.Best Production Practices": {
"message": "Best Production Practices",
"description": "The label for category Best Production Practices in sidebar karpor"
},
"sidebar.karpor.category.Developer Guide": {
"message": "Developer Guide",
"description": "The label for category Developer Guide in sidebar karpor"
},
"sidebar.karpor.category.Contribution Guide": {
"message": "Contribution Guide",
"description": "The label for category Contribution Guide in sidebar karpor"
},
"sidebar.karpor.category.Conventions": {
"message": "Conventions",
"description": "The label for category Conventions in sidebar karpor"
},
"sidebar.karpor.category.References": {
"message": "References",
"description": "The label for category References in sidebar karpor"
},
"sidebar.karpor.category.CLI Commands": {
"message": "CLI Commands",
"description": "The label for category CLI Commands in sidebar karpor"
}
}
4 changes: 2 additions & 2 deletions i18n/zh/docusaurus-plugin-content-docs-karpor/current.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version.label": {
"message": "v0.6 🚧",
"message": "v0.7 🚧",
"description": "The label for version current"
},
"sidebar.karpor.category.Getting Started": {
Expand Down Expand Up @@ -43,4 +43,4 @@
"message": "CLI Commands",
"description": "The label for category CLI Commands in sidebar karpor"
}
}
}
46 changes: 46 additions & 0 deletions i18n/zh/docusaurus-plugin-content-docs-karpor/version-v0.6.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"version.label": {
"message": "v0.6",
"description": "The label for version v0.6"
},
"sidebar.karpor.category.Getting Started": {
"message": "入门",
"description": "The label for category Getting Started in sidebar karpor"
},
"sidebar.karpor.category.Concepts": {
"message": "概念",
"description": "The label for category Concepts in sidebar karpor"
},
"sidebar.karpor.category.User Guide": {
"message": "用户手册",
"description": "The label for category User Guide in sidebar karpor"
},
"sidebar.karpor.category.How to Insight": {
"message": "如何洞察",
"description": "The label for category How to Insight in sidebar karpor"
},
"sidebar.karpor.category.Best Production Practices": {
"message": "生产最佳实践",
"description": "The label for category Best Production Practices in sidebar karpor"
},
"sidebar.karpor.category.Developer Guide": {
"message": "开发者手册",
"description": "The label for category Developer Guide in sidebar karpor"
},
"sidebar.karpor.category.Contribution Guide": {
"message": "贡献指南",
"description": "The label for category Contribution Guide in sidebar karpor"
},
"sidebar.karpor.category.Conventions": {
"message": "规约",
"description": "The label for category Conventions in sidebar karpor"
},
"sidebar.karpor.category.References": {
"message": "参考手册",
"description": "The label for category References in sidebar karpor"
},
"sidebar.karpor.category.CLI Commands": {
"message": "CLI Commands",
"description": "The label for category CLI Commands in sidebar karpor"
}
}
Loading
Loading