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

Backport PR #2611 to release/v1.7 for Fix broken links in the document files #2614

Conversation

vdaas-ci
Copy link
Collaborator

@vdaas-ci vdaas-ci commented Sep 11, 2024

Description

I have fixed the broken links in the document files.

According to fixing, I realized k8s/gateway/mirror is missing even though their links are written in the document file.
So, I have updated Makefile.d/k8s.mk to generate k8s/gateway/mirror.

Related Issue

Versions

  • Vald Version: v1.7.13
  • Go Version: v1.23.0
  • Rust Version: v1.80.0
  • Docker Version: v27.1.1
  • Kubernetes Version: v1.30.3
  • Helm Version: v3.15.3
  • NGT Version: v2.2.4
  • Faiss Version: v1.8.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration option to enable the gateway mirror feature in Kubernetes.
    • Added Kubernetes resources including ClusterRole, ClusterRoleBinding, ConfigMap, Deployment, Horizontal Pod Autoscaler, ServiceAccount, and PriorityClass for the vald-mirror-gateway.
    • Implemented a Pod Disruption Budget to maintain availability during disruptions.
  • Documentation

    • Updated hyperlinks in various documentation files to improve navigation and accuracy.
    • Corrected URLs in tutorials and user guides to point to stable resources.
  • Style

    • Enhanced formatting for improved readability in performance documentation.

* 🐛 📝 Fix broken links in document files

Signed-off-by: vankichi <[email protected]>

* style: format code with Gofumpt and Prettier

This commit fixes the style issues introduced in 07bb715 according to the output
from Gofumpt and Prettier.

Details: #2611

---------

Signed-off-by: vankichi <[email protected]>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
Copy link

cloudflare-workers-and-pages bot commented Sep 11, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: f042347
Status: ✅  Deploy successful!
Preview URL: https://20167fff.vald.pages.dev
Branch Preview URL: https://backport-release-v1-7-docume-ssuo.vald.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

Walkthrough

This pull request introduces several updates across multiple documentation files and Kubernetes resource definitions. Key changes include the addition of a configuration option to enable the gateway mirror feature in the Kubernetes manifest update process, updates to documentation links for improved navigation, and the introduction of various Kubernetes resources such as ConfigMaps, Deployments, and ServiceAccounts for the Vald mirror gateway. These modifications collectively enhance the deployment and documentation structure of the Vald application.

Changes

Files Change Summary
Makefile.d/k8s.mk Added configuration option --set gateway.mirror.enabled=true for enabling the gateway mirror feature.
docs/api/*.md Updated relative paths for "Response Status Code" links from ./status.md to ../status.md.
docs/contributing/coding-style.md Updated hyperlink for unit test guidelines from ./unit-test-guideline.md to ../unit-test-guideline.md.
docs/tutorial/*.md Updated URLs in tutorials to point to the main branch instead of feature branches for Vald deployments.
k8s/gateway/gateway/mirror/*.yaml Introduced various Kubernetes resources including ClusterRole, ClusterRoleBinding, ConfigMap, Deployment, HPA, PDB, PriorityClass, ServiceAccount, and Service for the Vald mirror gateway.

Possibly related PRs

Suggested labels

priority/low, type/documentation, size/L


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.
    • @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.

@vdaas-ci
Copy link
Collaborator Author

[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

@@ -1407,4 +1407,4 @@ Since each package has its purpose, we decided to apply different strategies to

For the rest of the `./pkg` packages, we decided to implement the unit test for the exported function only.

Please follow the [unit test guideline](./unit-test-guideline.md) for more details on how to implement good unit test.
Please follow the [unit test guideline](../unit-test-guideline.md) for more details on how to implement good unit test.
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.write-good> reported by reviewdog 🐶
"implement" is wordy or unneeded (write-good)

Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

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

LGTM

@vankichi vankichi merged commit f1da340 into release/v1.7 Sep 12, 2024
147 of 148 checks passed
@vankichi vankichi deleted the backport/release/v1.7/documentation/docs-k8s/fix-broken-links branch September 12, 2024 01:50
@coderabbitai coderabbitai bot mentioned this pull request Sep 23, 2024
2 tasks
@kpango kpango mentioned this pull request Oct 11, 2024
@coderabbitai coderabbitai bot mentioned this pull request Nov 16, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 12, 2024
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.

2 participants