Update deployment names for o3-mini and o1 in self-hosted documentation

[hasit]

No description provided.

[coderabbitai]

Walkthrough

The pull request updates four self-hosted documentation files for Azure DevOps, Bitbucket, GitHub, and GitLab. In each file, the environment configuration for Azure OpenAI deployment names is revised. Specifically, the placeholder values for AZURE_O3MINI_DEPLOYMENT_NAME and AZURE_O1_DEPLOYMENT_NAME have been reformatted from bracketed values to direct angle-bracket values. The documentation structure and instructions remain unchanged beyond these configuration modifications.

Changes

File(s)	Change Summary
docs/self-hosted/azure-devops.md, docs/self-hosted/bitbucket.md, docs/self-hosted/github.md, docs/self-hosted/gitlab.md	Updated environment variable definitions: replaced placeholders from bracketed formats (e.g., [<o1-deployment-name>]) to direct angle-bracket formats (e.g., <o1-deployment-name>).

Possibly related PRs

• docs: add guide for CodeRabbit GitHub integration #133: Modifies Azure OpenAI deployment names with similar formatting updates in different documentation contexts.
• Update API key format in self-hosted documentation #199: Updates environment variable configurations by switching bracketed placeholders to direct inputs.
• Update github env var examples #157: Involves analogous changes to Azure OpenAI deployment variable formats across various documentation files.

Suggested reviewers

• aravindputrevu
• alexcoderabbitai

Poem

I hopped through docs on a starry night,
Changing brackets to clarity, oh what a sight!
Azure deployments now clearly shine,
With angle brackets that align just fine.
A rabbit’s cheer for changes so bright! 🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6acc3e5 and 771169f.

📒 Files selected for processing (4)

• docs/self-hosted/azure-devops.md (1 hunks)
• docs/self-hosted/bitbucket.md (1 hunks)
• docs/self-hosted/github.md (1 hunks)
• docs/self-hosted/gitlab.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (5)

docs/self-hosted/bitbucket.md (2)

59-60: Updated Deployment Placeholders:
The environment variable values for AZURE_O3MINI_DEPLOYMENT_NAME and AZURE_O1_DEPLOYMENT_NAME have been updated from bracketed placeholder formats to angle-bracket notation. This improves clarity on the expected inputs for these fields.

---

62-62: Verify Optional Configuration:
The variable AZURE_O1MINI_DEPLOYMENT_NAME remains in the original bracketed format. Please confirm if this is intentional or if it should be updated for consistency with the other deployment names.

docs/self-hosted/azure-devops.md (1)

66-67: Clarify Deployment Name Configuration:
The placeholders for AZURE_O3MINI_DEPLOYMENT_NAME and AZURE_O1_DEPLOYMENT_NAME have been reformatted to use angle brackets, clearly indicating that users should provide the actual deployment names. This change aligns with similar updates in the other self-hosted documentation files.

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

65-66: Standardized Deployment Name Format:
The update changes the deployment name placeholders for Azure OpenAI from the old bracketed format to the new angle-bracket format for AZURE_O3MINI_DEPLOYMENT_NAME and AZURE_O1_DEPLOYMENT_NAME. This update enhances consistency and user clarity throughout the documentation.

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

70-71: Consistent Deployment Variables in .env File:
The environment variables AZURE_O3MINI_DEPLOYMENT_NAME and AZURE_O1_DEPLOYMENT_NAME have been updated to use angle brackets instead of the previous bracketed format. This revision clarifies that actual deployment names are required, ensuring consistency with the other self-hosted documentation files.

---

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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:	771169f
Status:	✅  Deploy successful!
Preview URL:	https://068aee66.coderabbit-docs.pages.dev
Branch Preview URL:	https://hasit-o3.coderabbit-docs.pages.dev

View logs