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: make the edit page on github point to correct resource #3327

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

Varun-Kolanu
Copy link
Contributor

@Varun-Kolanu Varun-Kolanu commented Oct 25, 2024

Description

  • The older link was pointing to a wrong resource.
  • Involved finding where the correct resource exists.
  • Changed the link to now open the correct markdown files
  • Previous error page on clicking the link:

image

  • Current working after updating:

image

Related issue(s)
Fixes #3300

Copy link

coderabbitai bot commented Oct 25, 2024

Walkthrough

The changes involve a modification to the edit-page-config.json file, specifically updating the href value from a URL pointing to the "pages" directory to a new URL pointing to the "markdown" directory. This change aims to resolve a mis-linking issue that resulted in a 404 error when attempting to access the edit page for documentation.

Changes

File Change Summary
config/edit-page-config.json Updated href from "https://github.com/asyncapi/website/blob/master/pages" to "https://github.com/asyncapi/website/blob/master/markdown"

Assessment against linked issues

Objective Addressed Explanation
Fix the mis-linked page (3300)

🐰 In the land of code, a link was astray,
With a hop and a jump, it found a new way.
From pages to markdown, the path now is clear,
No more 404s, let’s give a cheer!
Hooray for the changes, let’s dance and delight,
For the rabbit’s quick fix made everything right! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bb69a47 and 4fb7e2b.

📒 Files selected for processing (1)
  • config/edit-page-config.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • config/edit-page-config.json

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

Copy link

netlify bot commented Oct 25, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4fb7e2b
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/671b43bcdd16d90008873433
😎 Deploy Preview https://deploy-preview-3327--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.32%. Comparing base (bb69a47) to head (4fb7e2b).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3327   +/-   ##
=======================================
  Coverage   47.32%   47.32%           
=======================================
  Files          22       22           
  Lines         672      672           
=======================================
  Hits          318      318           
  Misses        354      354           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asyncapi-bot
Copy link
Contributor

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 46
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3327--asyncapi-website.netlify.app/

@Varun-Kolanu Varun-Kolanu mentioned this pull request Oct 25, 2024
2 tasks
Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

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

Working correctly for website pages

@akshatnema
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 67aafb6 into asyncapi:master Oct 25, 2024
36 checks passed
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.

[BUG] Mis-linked page
3 participants