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 docs v3 redirects #13949

Merged
merged 3 commits into from
Sep 17, 2024
Merged

Fix docs v3 redirects #13949

merged 3 commits into from
Sep 17, 2024

Conversation

andrewjschuang
Copy link
Collaborator

@andrewjschuang andrewjschuang commented Sep 13, 2024

WHY

Summary by CodeRabbit

  • New Features

    • Streamlined routing configuration by removing outdated paths and redirects related to version 3 of the documentation.
  • Bug Fixes

    • Removed deprecated rewrite and redirect rules to enhance clarity in documentation navigation.

Copy link

vercel bot commented Sep 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
pipedream ❌ Failed (Inspect) Sep 17, 2024 10:53pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Sep 17, 2024 10:53pm
pipedream-docs ⬜️ Ignored (Inspect) Sep 17, 2024 10:53pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Sep 17, 2024 10:53pm

Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

The changes involve the removal of specific rewrite rules and redirect paths in the vercel.json configuration file. The rewrite rules for /docs/v3 and its sub-paths have been eliminated, indicating that version 3 of the documentation is no longer supported. Additionally, redirects from certain /docs/v3 paths to current documentation locations have also been removed, further confirming the deprecation of version 3.

Changes

File Change Summary
docs-v2/vercel.json Removed rewrite rules for /docs/v3 and /docs/v3/(.*); removed redirects from /docs/v3/components/quickstart/nodejs/sources to /docs/components/sources-quickstart and from /docs/v3/api/sse to /docs/destinations/sse.

Poem

In the meadow where rabbits play,
Old paths have vanished, gone astray.
With hops and skips, we cheer anew,
For clearer trails and skies so blue!
Let’s bound ahead, with joy we sing,
Embracing change, what joy it brings! 🐇✨


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 generate interesting stats about this repository and render them as a table.
    -- @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.

@@ -1,14 +1,4 @@
{
"rewrites": [
Copy link
Contributor

Choose a reason for hiding this comment

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

You'll want to move these to the redirects section instead of removing them entirely, since we still have some /docs/v3 links out there, so we want to redirect /docs/v3 to /docs

@@ -226,10 +216,6 @@
"source": "/docs/components/quickstart/nodejs/sources",
"destination": "/docs/components/sources-quickstart"
},
{
Copy link
Contributor

Choose a reason for hiding this comment

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

These are fine to remove once you have the redirect to handle the root /v3 path

@@ -289,10 +275,6 @@
{
"source": "/docs/errors/",
"destination": "/docs/workflows/errors"
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Also fine to remove

@andrewjschuang andrewjschuang merged commit 6756d03 into master Sep 17, 2024
7 of 9 checks passed
@andrewjschuang andrewjschuang deleted the docs-remove-v3-redirects branch September 17, 2024 23:43
@andrewjschuang andrewjschuang changed the title Remove docs v3 redirects Fix docs v3 redirects Sep 18, 2024
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