Add onprem learning config

[NickBusey]

No description provided.

[coderabbitai]

Walkthrough

The pull request updates the docs/self-hosted/github.md document to include new configuration options for self-hosting CodeRabbit with GitHub. It introduces two new environment variables: ON_PREM_KNOWLEDGE_BASE, which enables knowledge base features, and ON_PREM_KNOWLEDGE_BASE_BRANCH, which specifies the branch for storing knowledge base JSON files. The document's structure remains unchanged, retaining existing sections and notes related to Azure OpenAI configuration.

Changes

File Path	Change Summary
docs/self-hosted/github.md	Added two new environment variables: ON_PREM_KNOWLEDGE_BASE (boolean) and ON_PREM_KNOWLEDGE_BASE_BRANCH (defaults to coderabbitai/data).

Possibly related PRs

• docs: add guide for CodeRabbit GitHub integration #133: Enhances documentation for integrating CodeRabbit with GitHub, directly related to the updates made in this PR.
• docs: Improve docs SEO  #142: Focuses on improving SEO for documentation and includes updates to GitHub integration documentation, indirectly related to the main PR.

Suggested reviewers

• aravindputrevu

🐇 In the garden, where knowledge blooms,
New branches sprout, dispelling glooms.
With settings fresh, our paths align,
CodeRabbit thrives, oh how divine!
Let features grow, let wisdom flow,
In self-hosted realms, we joyfully sow! 🌱

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	d0ce235
Status:	✅  Deploy successful!
Preview URL:	https://54046449.coderabbit-docs.pages.dev
Branch Preview URL:	https://nickbusey-patch-1.coderabbit-docs.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/self-hosted/github.md (1)

111-114: LGTM! Documentation is clear and well-structured.

The new environment variables are well-documented with clear descriptions of their purpose.

Consider adding the following information to help users better understand the implications:

1. Branch management:
   • Will the branch be created automatically if it doesn't exist?
   • What permissions are required for branch operations?
2. Security considerations:
   • Who should have access to the knowledge base branch?
   • Best practices for securing sensitive information in the knowledge base
3. Operational aspects:
   • Backup and recovery procedures for the knowledge base
   • How to monitor the size and growth of the knowledge base

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5224d4a and d0ce235.

📒 Files selected for processing (1)

• docs/self-hosted/github.md (1 hunks)