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

fix typo #2504

Merged
merged 1 commit into from
May 21, 2024
Merged

fix typo #2504

merged 1 commit into from
May 21, 2024

Conversation

datelier
Copy link
Contributor

@datelier datelier commented May 21, 2024

Description

SSIA

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
    • Added a new "Status Code" section with codes and descriptions to the API documentation.

@datelier datelier requested review from a team, kmrmt and kpango and removed request for a team May 21, 2024 06:03
Copy link
Contributor

coderabbitai bot commented May 21, 2024

Walkthrough

Walkthrough

The recent update to the documentation introduces a new "Status Code" section in the filter-gateway.md file. This section provides a list of status codes along with their descriptions, enhancing the clarity and comprehensiveness of the API documentation by detailing the various status codes that the filter gateway may return.

Changes

Files Change Summary
docs/api/filter-gateway.md Added a new "Status Code" section with codes and descriptions

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.

@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

| code | desc. |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [documents testlint] <eslint.rules.en-spell> reported by reviewdog 🐶
CANCELLED => CANCELED (en-spell)

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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1752537 and 9400e5f.
Files selected for processing (1)
  • docs/api/filter-gateway.md (1 hunks)
Additional Context Used
LanguageTool (9)
docs/api/filter-gateway.md (9)

Near line 138: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to insert a large number of objects. ```rpc service Filter { rpc...


Near line 247: “Google” is a proper noun and needs to be capitalized.
Context: ...ogle.rpc.Status | | the status of google RPC. | - Object.Loc...


Near line 396: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | the list of Object.Location. | - Object.Location | field |...


Near line 546: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... recommended method to update the large amount of objects. ```rpc service Filter { ...


Near line 656: “Google” is a proper noun and needs to be capitalized.
Context: ...ogle.rpc.Status | | the status of google RPC. | - Object.Loc...


Near line 811: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | the list of Object.Location. | - Object.Location | field |...


Near line 1068: “Google” is a proper noun and needs to be capitalized.
Context: ...ogle.rpc.Status | | the status of google RPC. | - Object.Loc...


Near line 1223: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | the list of Object.Location. | - Object.Location | field |...


Near line 1464: “Google” is a proper noun and needs to be capitalized.
Context: ...ogle.rpc.Status | | the status of google RPC | - Search.Response | f...

Additional comments not posted (1)
docs/api/filter-gateway.md (1)

1480-1490: Correct the typo in the "Status Code" section.

The addition of the "Status Code" section provides clear and concise information about possible status codes, which enhances the documentation's utility and user guidance.

@kmrmt kmrmt merged commit 8a36249 into main May 21, 2024
23 checks passed
@kmrmt kmrmt deleted the docs/api/fix-typo branch May 21, 2024 06:09
kpango pushed a commit that referenced this pull request May 21, 2024
Signed-off-by: kpango <kpango@vdaas.org>
kpango pushed a commit that referenced this pull request May 21, 2024
Signed-off-by: kpango <kpango@vdaas.org>
hlts2 pushed a commit that referenced this pull request Jun 25, 2024
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