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: dead links #1025

Merged
merged 1 commit into from
Jun 27, 2024
Merged

fix: dead links #1025

merged 1 commit into from
Jun 27, 2024

Conversation

nicecui
Copy link
Collaborator

@nicecui nicecui commented Jun 27, 2024

What's Changed in this PR

gtctl provides the same features as helm, so we moved it to reference to provide a better user experience to the user guide documentation.
When gtctl becomes more powerful in the future, we can move it back.

Checklist

  • Please ensure that the content in summary.yml matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

Summary by CodeRabbit

  • Documentation
    • Updated the link for Kubernetes to point to the new Deploy on Kubernetes Overview section.
    • Removed the outdated gtctl link.

@nicecui nicecui requested a review from a team as a code owner June 27, 2024 03:04
Copy link
Contributor

coderabbitai bot commented Jun 27, 2024

Walkthrough

The updates to overview.md in the documentation involve adjusting the references for better navigation. The link to Kubernetes has been redirected to a different section of the documentation (./deploy-on-kubernetes/overview.md), and the link to gtctl has been removed altogether.

Changes

Files Change Summary
docs/nightly/zh/user-guide/operations/overview.md Updated Kubernetes link to ./deploy-on-kubernetes/overview.md, Removed gtctl link

Poem

In the docs a change was made,
Redirecting pathways, none is swayed.
Kubernetes finds a new home,
gtctl link now alone.
Navigate with ease, through each page,
For clarity's the badge we wage.
🐰📚✨


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

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.

Copy link

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 55344d3
Status: ✅  Deploy successful!
Preview URL: https://3ab4ca15.greptime-docs.pages.dev
Branch Preview URL: https://fix-dead-links.greptime-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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8760e2b and 55344d3.

Files selected for processing (1)
  • docs/nightly/zh/user-guide/operations/overview.md (1 hunks)
Additional comments not posted (1)
docs/nightly/zh/user-guide/operations/overview.md (1)

7-7: Updated Link for Kubernetes

The link for Kubernetes has been updated to point to ./deploy-on-kubernetes/overview.md. Please confirm that this document exists and accurately reflects the intended content.

Verification successful

Verified Link for Kubernetes

The link for Kubernetes has been correctly updated to point to ./deploy-on-kubernetes/overview.md, and the target document exists.

  • docs/nightly/zh/user-guide/operations/deploy-on-kubernetes/overview.md
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the existence of the new Kubernetes link.

# Test: Check if the new Kubernetes document exists. Expect: File exists.
fd --type f 'overview.md' 'docs/nightly/zh/user-guide/operations/deploy-on-kubernetes'

Length of output: 155

Copy link
Contributor

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

LGTM

@nicecui nicecui merged commit 228efcd into main Jun 27, 2024
6 checks passed
@nicecui nicecui deleted the fix/dead-links branch June 27, 2024 10:43
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.

3 participants