website icon indicating copy to clipboard operation
website copied to clipboard

Published 20 hours ago • verified publisher icon asyncapi

docs: add missing excerpts to hide imports

Open bandantonio opened this issue 1 year ago • 8 comments

Description

Adds missing excerpts to blog posts to hide jsx-related imports:

Before After
Before After

Related issue(s)

❗️Must be merged right after #3269

Summary by CodeRabbit

  • New Features

    • Updated the metadata format in multiple documentation reports from byline to excerpt, enhancing how introductory information is presented.

  • Documentation

    • Maintained the content and structure of the AsyncAPI documentation reports for April, May, June, and July 2023, while improving metadata clarity.

bandantonio avatar Oct 03 '24 21:10 bandantonio

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
Latest commit 81c2dc82809fce2761ac4fb1c429f8767b2dcb56
Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/676018461fac9c0008ddf70e
Deploy Preview https://deploy-preview-3270--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.

netlify[bot] avatar Oct 03 '24 21:10 netlify[bot]

⚡️ Lighthouse report for the changes in this PR:

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

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

asyncapi-bot avatar Oct 03 '24 21:10 asyncapi-bot

lgtm, but there are some addition edits, like removal of empty spaces that I think you also have in another PR, not sure if that is some autoformatter that you use - so yeah, brace yourself - merge conflicts are coming 😉

derberg avatar Oct 03 '24 22:10 derberg

Walkthrough

The changes involve updating the front matter metadata of several documentation reports for AsyncAPI from a byline field to an excerpt field. This modification affects the files for the months of April, May, June, and July 2023. The content within the reports remains unchanged, preserving the detailed information regarding documentation updates, community engagement, and contributions.

Changes

File Change Summary
markdown/blog/2023-April-docs-report.md Changed byline to excerpt in front matter.
markdown/blog/2023-May-docs-report.md Changed byline to excerpt in front matter.
markdown/blog/2023-June-docs-report.md Changed byline to excerpt in front matter.
markdown/blog/2023-July-docs-report.md Changed byline to excerpt in front matter.

Poem

In the land of docs, where rabbits hop,
The bylines changed, but the info won’t stop.
Excerpts now lead, concise and bright,
Telling our tales in the soft moonlight.
With each report, our stories grow,
A community thriving, as we all know! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9fca5d8fef192ad47270697c2d9c2b8ad8765062 and 4d50d1da7794134a75016d8264169b58ee6d5945.

📒 Files selected for processing (4)
  • markdown/blog/2023-April-docs-report.md (1 hunks)
  • markdown/blog/2023-july-docs-report.md (1 hunks)
  • markdown/blog/2023-june-docs-report.md (1 hunks)
  • markdown/blog/2023-may-docs-report.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • markdown/blog/2023-April-docs-report.md
  • markdown/blog/2023-july-docs-report.md
  • markdown/blog/2023-june-docs-report.md
  • markdown/blog/2023-may-docs-report.md

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.

coderabbitai[bot] avatar Oct 04 '24 19:10 coderabbitai[bot]

lgtm, but there are some addition edits, like removal of empty spaces that I think you also have in another PR, not sure if that is some autoformatter that you use - so yeah, brace yourself - merge conflicts are coming 😉

@derberg Yes, you're right, it was my VS Code auto-formatter. I updated the PR, please have a look. Merge conflicts will be there anyway after deploying the update with fragments (#3269), so yeah, I'm ready 😎

bandantonio avatar Oct 04 '24 19:10 bandantonio

@bandantonio and here are the conflicts 😄

derberg avatar Oct 09 '24 10:10 derberg

@derberg Yeah 😁😎, I will take care of them later today.

bandantonio avatar Oct 09 '24 10:10 bandantonio

@quetzalliwrites please approve and merge

derberg avatar Oct 09 '24 19:10 derberg

Hey @bandantonio , Can you please again resolve the merge conflicts in the PR? Sorry for pinging again.

akshatnema avatar Nov 30 '24 11:11 akshatnema

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 86.59%. Comparing base (dc7d0d3) to head (81c2dc8).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #3270   +/-   ##
=======================================
  Coverage   86.59%   86.59%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          575      575           
  Misses         89       89

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Dec 01 '24 20:12 codecov[bot]

Hey @bandantonio , Can you please again resolve the merge conflicts in the PR? Sorry for pinging again.

@akshatnema Done. I feel like this PR overlaps with the updates I made in #3393 so there are 0 files changed.

bandantonio avatar Dec 01 '24 20:12 bandantonio

@bandantonio can you please elaborate this PR

sambhavgupta0705 avatar Dec 16 '24 12:12 sambhavgupta0705

/update

sambhavgupta0705 avatar Dec 16 '24 12:12 sambhavgupta0705

Looks like the changes that were intended for this PR are merged with some other PR as per comment https://github.com/asyncapi/website/pull/3270#issuecomment-2510237547

anshgoyalevil avatar Dec 16 '24 12:12 anshgoyalevil