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

change fixed version to replace string #2506

Merged

Conversation

kmrmt
Copy link
Contributor

@kmrmt kmrmt commented May 23, 2024

Description

change fixed version in document to version replacer

Related Issue

Versions

  • Go Version: 1.22.3
  • Rust Version: 1.77.2
  • Docker Version: 20.10.8
  • Kubernetes Version: v1.30.0
  • NGT Version: 2.2.1

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • Documentation
    • Updated the URL in the documentation to use a version placeholder VERSION instead of v1.3.1 for referencing Go Doc.

Copy link
Contributor

coderabbitai bot commented May 23, 2024

Warning

Rate Limit Exceeded

@kmrmt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 37 minutes and 29 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 899dbb4 and 0cf0ce1.

Walkthrough

The change involves updating the documentation for the component agent by replacing a specific version placeholder (v1.3.1) with a more generic VERSION placeholder in the URL referencing Go Doc. This update ensures the documentation remains accurate and adaptable to future version changes without needing specific version updates.

Changes

Files Change Summary
docs/overview/component/agent.md Updated URL in Go Doc reference from v1.3.1 to VERSION placeholder.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@kmrmt kmrmt requested review from hlts2 and datelier May 23, 2024 06:44
@vdaas-ci
Copy link
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>
@kmrmt kmrmt force-pushed the documentation/overview/component/agent-go-doc-versioning branch from 09eb465 to 899dbb4 Compare May 23, 2024 06:44
Copy link

cloudflare-workers-and-pages bot commented May 23, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0cf0ce1
Status: ✅  Deploy successful!
Preview URL: https://190738b3.vald.pages.dev
Branch Preview URL: https://documentation-overview-compo.vald.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: 1

Outside diff range and nitpick comments (4)
docs/overview/component/agent.md (4)

Line range hint 13-13: Consider revising the preposition for clarity.

- Store index data along to the user requests
+ Store index data according to the user requests

Line range hint 45-45: Add a missing preposition for grammatical correctness.

- Get the nearest neighbor vectors of the request vector from NGT indexes.
+ Get the nearest neighbor vectors of the request vector from the NGT indexes.

Line range hint 140-140: Add alternate text to images for accessibility.

- <img src="../../../assets/docs/overview/component/agent/sidecar_backup.png" />
+ <img src="../../../assets/docs/overview/component/agent/sidecar_backup.png" alt="Sidecar Backup Process" />

Line range hint 145-145: Add alternate text to images for accessibility.

- <img src="../../../assets/docs/overview/component/agent/sidecar_restore.png" />
+ <img src="../../../assets/docs/overview/component/agent/sidecar_restore.png" alt="Sidecar Restore Process" />
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 57c9376 and 899dbb4.
Files selected for processing (1)
  • docs/overview/component/agent.md (1 hunks)
Additional Context Used
LanguageTool (2)
docs/overview/component/agent.md (2)

Near line 13: The preposition ‘as’ seems more likely in this position.
Context: ...ponsible for: - Store index data along to the user requests - The store destina...


Near line 45: Possible missing preposition found.
Context: ...re stored in the vqueue. - Search - Get the nearest neighbor vectors of the req...

Markdownlint (3)
docs/overview/component/agent.md (3)

77: null
Images should have alternate text (alt text)


140: null
Images should have alternate text (alt text)


145: null
Images should have alternate text (alt text)

Additional comments not posted (1)
docs/overview/component/agent.md (1)

79-79: Replace fixed version number with a dynamic placeholder.

This change aligns with the PR's goal to make version management more dynamic and less error-prone.

docs/overview/component/agent.md Outdated Show resolved Hide resolved
datelier
datelier previously approved these changes May 23, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com>
Copy link
Collaborator

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM!

@datelier datelier merged commit 529e3d0 into main May 23, 2024
21 checks passed
@datelier datelier deleted the documentation/overview/component/agent-go-doc-versioning branch May 23, 2024 07:12
hlts2 pushed a commit that referenced this pull request Jun 25, 2024
* change fixed version to replace string

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>

* Update docs/overview/component/agent.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com>

---------

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>
Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
hlts2 added a commit that referenced this pull request Jun 25, 2024
* fix links (#2500)

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>

* fix indent and link (#2501)

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>

* fix link (#2502)

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>

* fix typo (#2503)

* fix typo (#2504)

* change fixed version to replace string (#2506)

* change fixed version to replace string

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>

* Update docs/overview/component/agent.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com>

---------

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>
Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Signed-off-by: Kosuke Morimoto <ksk@vdaas.org>
Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com>
Co-authored-by: Kosuke Morimoto <ksk@vdaas.org>
Co-authored-by: datelier <57349093+datelier@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants