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

Revised PnP error message #3336

Closed
wants to merge 2 commits into from
Closed

Conversation

atGit2021
Copy link
Contributor

@atGit2021 atGit2021 self-assigned this Dec 5, 2024
@atGit2021 atGit2021 requested a review from CarsonF as a code owner December 5, 2024 22:27
Copy link

coderabbitai bot commented Dec 5, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.

@atGit2021 atGit2021 requested a review from rdonigian December 5, 2024 22:28
@atGit2021 atGit2021 changed the title revised error message and added link to guide per product team request Revised PnP error message Dec 5, 2024
Copy link
Member

@CarsonF CarsonF left a comment

Choose a reason for hiding this comment

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

I'd really rather not store this link in the db for every error.
Can we just a generic link to the UI instead?

@atGit2021
Copy link
Contributor Author

atGit2021 commented Dec 5, 2024

I'd really rather not store this link in the db for every error. Can we just a generic link to the UI instead?

when you say "generic link", do you mean just use this link which just points to the overall page vs using the specific links that point to the relative error within the page? And if so, do you want me to pull it from the local.env config file?

@CarsonF
Copy link
Member

CarsonF commented Dec 5, 2024

when you say "generic link", do you mean just use this link which just points to the overall page vs using the specific links that point to the relative error within the page? And if so, do you want me to pull it from the local.env config file?

Yeah and no it could be hard coded. If that's not acceptable I think we need to do something else.

@atGit2021
Copy link
Contributor Author

when you say "generic link", do you mean just use this link which just points to the overall page vs using the specific links that point to the relative error within the page? And if so, do you want me to pull it from the local.env config file?

Yeah and no it could be hard coded. If that's not acceptable I think we need to do something else.

I think it will be ok, but will ping product team to confirm

@atGit2021 atGit2021 requested a review from CarsonF December 5, 2024 23:53
@CarsonF
Copy link
Member

CarsonF commented Dec 16, 2024

Pulled into #3342

@CarsonF CarsonF closed this Dec 16, 2024
@CarsonF CarsonF deleted the 0318-Revise-PnP-Error-Message branch December 16, 2024 18:59
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