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

@coderabbitai #158

Closed
wants to merge 2 commits into from
Closed

@coderabbitai #158

wants to merge 2 commits into from

Conversation

aravindputrevu
Copy link
Member

@aravindputrevu aravindputrevu commented Nov 28, 2024

@coderabbitai summary

Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes involve significant updates to two documentation files: pricing.md and self-hosted-gitlab.md. The pricing.md document has been restructured to improve the organization and clarity of pricing plans, including detailed descriptions of the Free, Lite, and Pro plans, a revamped comparison section, and expanded instructions on subscription management. The self-hosted-gitlab.md document has been modified to reflect a new login URL, clarified onboarding steps, and detailed requirements for OAuth2 applications, along with a new section on IP whitelisting.

Changes

File Change Summary
docs/about/pricing.md - Refined structure and content for pricing plans (Free, Lite, Pro).
- Explicit pricing details for Lite and Pro plans (monthly/annual rates).
- Reformatted "Plan Comparison" section for clarity.
- Expanded "Subscription Management" section with detailed instructions.
- Added visual aids for seat management processes.
docs/platforms/self-hosted-gitlab.md - Updated login URL to include a query parameter for free trial.
- Clarified onboarding process with Admin Access Token details.
- Divided onboarding into Automated and Manual subsections with detailed steps.
- Specified requirements for creating OAuth2 applications.
- Added section on whitelisting CodeRabbit IP addresses.

Possibly related PRs

Suggested reviewers

  • dk03051996

🐇 In the meadow, where bunnies play,
New pricing plans brighten the day.
With clearer paths and steps to share,
Subscription management, beyond compare!
Hop along, dear users, don't delay,
Explore the changes, and hop away! 🐰✨


🪧 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.

[dependabot skip]
Copy link

cloudflare-workers-and-pages bot commented Nov 28, 2024

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4fc45be
Status: ✅  Deploy successful!
Preview URL: https://04a2a7a0.coderabbit-docs.pages.dev
Branch Preview URL: https://login-404-fix.coderabbit-docs.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)
docs/platforms/self-hosted-gitlab.md (2)

Line range hint 183-188: Enhance IP whitelisting section with security note

Consider adding a security note at the beginning of this section to emphasize the importance of IP whitelisting for secure integration. Also, consider formatting the IPs in a more readable way.

 ### **Step 5: Whitelist CodeRabbit IP address**
 
-Use this CodeRabbit IP if your instance requires IP whitelisting
-`35.222.179.152/32` and `34.170.211.100/32`.
+> **Security Note**: If your GitLab instance is behind a firewall or requires IP whitelisting,
+> ensure you whitelist the following CodeRabbit IPs:
+> - `35.222.179.152/32`
+> - `34.170.211.100/32`
 
 VPN tunneling is available as an add-on package. Please reach out to us at
 [[email protected]](mailto:[email protected]) if you are interested.

Line range hint 1-188: Documentation structure looks good with minor enhancement opportunities

The documentation is well-structured and provides a clear step-by-step guide for integration. A few suggestions to enhance readability:

  • Consider adding a prerequisites section at the beginning
  • Add a troubleshooting section for common issues
  • Consider adding a table of contents for easier navigation
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c2a0670 and 4fc45be.

📒 Files selected for processing (2)
  • docs/about/pricing.md (1 hunks)
  • docs/platforms/self-hosted-gitlab.md (1 hunks)
🔇 Additional comments (2)
docs/about/pricing.md (1)

Line range hint 1-1: Verify PR scope: Documentation changes vs login fix

This PR's title suggests it's meant to fix a login 404 issue, but the changes in this file are purely documentation-related. Could you clarify if:

  1. The login fix is in other files not shown here
  2. These documentation changes are related to the login fix
  3. The PR title needs to be updated to reflect the actual changes
docs/platforms/self-hosted-gitlab.md (1)

Line range hint 109-112: Verify OAuth2 callback URL configuration

The OAuth2 callback URL (https://app.coderabbit.ai/login) doesn't match the login URL pattern shown earlier (https://app.coderabbit.ai/login?free-trial). Please verify if this is intentional or if the callback URL needs to be updated for consistency.

Comment on lines +104 to +116
| Feature | Free Plan | Pro Plan | Lite Plan |
| ------------------------------ | ----------------- | ----------------- | ---------------- |
| **Free Trial** | 14-day free trial | 14-day free trial | No |
| **Private Repos** | Limited access | Unlimited access | Limited access |
| **Public Repos** | Unlimited access | Unlimited access | Unlimited access |
| **Pull Request Summarization** | Included | Included | Included |
| **Line-by-Line Reviews** | Public repos only | All repos | All repos |
| **Conversational Bot** | No | Yes | Yes |
| **Linters and SAST tools** | No | No | Yes |
| **Jira & Linear Integration** | No | No | Yes |
| **ROI dashboards** | No | No | Yes |
| **Customizable reports** | No | No | Yes |
| **Price** | Free forever | $15 per seat/mo | $30 per seat/mo |
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Critical: Fix inconsistencies in the plan comparison table

The table contains several discrepancies with the detailed plan descriptions above:

  1. The Pro and Lite plan features appear to be swapped:

    • Linters, SAST tools, Jira integration, and dashboards are listed under Pro in the detailed section but shown under Lite in the table.
  2. Pricing information is incorrect:

    • Table shows Pro at $15/seat/mo, but the detailed section states $30/month
    • Table shows Lite pricing is $30/seat/mo, but the detailed section states $15/month
  3. Free Trial information is inconsistent:

    • Table shows "No" for Lite plan, but the detailed section states "This plan begins with a 14-day free trial"

Apply this diff to fix the inconsistencies:

-| Feature                        | Free Plan         | Pro Plan          | Lite Plan        |
-| ------------------------------ | ----------------- | ----------------- | ---------------- |
-| **Free Trial**                 | 14-day free trial | 14-day free trial | No               |
-| **Private Repos**              | Limited access    | Unlimited access  | Limited access   |
-| **Public Repos**               | Unlimited access  | Unlimited access  | Unlimited access |
-| **Pull Request Summarization** | Included          | Included          | Included         |
-| **Line-by-Line Reviews**       | Public repos only | All repos         | All repos        |
-| **Conversational Bot**         | No                | Yes               | Yes              |
-| **Linters and SAST tools**     | No                | No                | Yes              |
-| **Jira & Linear Integration**  | No                | No                | Yes              |
-| **ROI dashboards**             | No                | No                | Yes              |
-| **Customizable reports**       | No                | No                | Yes              |
-| **Price**                      | Free forever      | $15 per seat/mo   | $30 per seat/mo  |
+| Feature                        | Free Plan         | Lite Plan         | Pro Plan         |
+| ------------------------------ | ----------------- | ----------------- | ---------------- |
+| **Free Trial**                 | 14-day free trial | 14-day free trial | 14-day free trial|
+| **Private Repos**              | Limited access    | Unlimited access  | Unlimited access |
+| **Public Repos**               | Unlimited access  | Unlimited access  | Unlimited access |
+| **Pull Request Summarization** | Included          | Included          | Included         |
+| **Line-by-Line Reviews**       | Public repos only | All repos         | All repos        |
+| **Conversational Bot**         | No                | Yes               | Yes              |
+| **Linters and SAST tools**     | No                | No                | Yes              |
+| **Jira & Linear Integration**  | No                | No                | Yes              |
+| **ROI dashboards**             | No                | No                | Yes              |
+| **Customizable reports**       | No                | No                | Yes              |
+| **Price**                      | Free forever      | $15 per seat/mo   | $30 per seat/mo  |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Feature | Free Plan | Pro Plan | Lite Plan |
| ------------------------------ | ----------------- | ----------------- | ---------------- |
| **Free Trial** | 14-day free trial | 14-day free trial | No |
| **Private Repos** | Limited access | Unlimited access | Limited access |
| **Public Repos** | Unlimited access | Unlimited access | Unlimited access |
| **Pull Request Summarization** | Included | Included | Included |
| **Line-by-Line Reviews** | Public repos only | All repos | All repos |
| **Conversational Bot** | No | Yes | Yes |
| **Linters and SAST tools** | No | No | Yes |
| **Jira & Linear Integration** | No | No | Yes |
| **ROI dashboards** | No | No | Yes |
| **Customizable reports** | No | No | Yes |
| **Price** | Free forever | $15 per seat/mo | $30 per seat/mo |
| Feature | Free Plan | Lite Plan | Pro Plan |
| ------------------------------ | ----------------- | ----------------- | ---------------- |
| **Free Trial** | 14-day free trial | 14-day free trial | 14-day free trial|
| **Private Repos** | Limited access | Unlimited access | Unlimited access |
| **Public Repos** | Unlimited access | Unlimited access | Unlimited access |
| **Pull Request Summarization** | Included | Included | Included |
| **Line-by-Line Reviews** | Public repos only | All repos | All repos |
| **Conversational Bot** | No | Yes | Yes |
| **Linters and SAST tools** | No | No | Yes |
| **Jira & Linear Integration** | No | No | Yes |
| **ROI dashboards** | No | No | Yes |
| **Customizable reports** | No | No | Yes |
| **Price** | Free forever | $15 per seat/mo | $30 per seat/mo |

Comment on lines +22 to 23
**Visit CodeRabbit:** Visit our [Login](https://app.coderabbit.ai/login?free-trial) page and
select Self-Hosted GitLab
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Update remaining login URL in GitHub Enterprise Server documentation

Found an inconsistent login URL in docs/platforms/github-enterprise-server.md that still uses the old domain coderabbit.ai/login instead of app.coderabbit.ai/login. All other documentation files are using the new domain correctly.

  • docs/platforms/github-enterprise-server.md: Update the login URL from https://coderabbit.ai/login to https://app.coderabbit.ai/login?free-trial
🔗 Analysis chain

Verify login URL consistency across documentation

The login URL has been updated to https://app.coderabbit.ai/login?free-trial. Let's ensure this change is reflected consistently across all documentation files.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining references to the old domain
rg -i "coderabbit\.ai/login" --type md

# Search for inconsistent login URLs
rg -i "app\.coderabbit\.ai/login" --type md

Length of output: 2633

@aravindputrevu aravindputrevu changed the title fix login 404 @coderabbitai Nov 28, 2024
@Pavaningithub Pavaningithub reopened this Nov 28, 2024
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 this pull request may close these issues.

2 participants