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.

Sign up for GitHub

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

Jump to bottom

docs: add missing excerpts to hide imports #3270

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: add missing excerpts to hide imports #3270

wants to merge 2 commits into from
+4 −4

Conversation

bandantonio
Copy link
Contributor

@bandantonio bandantonio commented Oct 3, 2024 •
edited by coderabbitai bot
Loading

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.

@netlify Netlify
Copy link

netlify bot commented Oct 3, 2024 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4d50d1d
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6706c26996d4c300075593f4
😎 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.

@bandantonio bandantonio mentioned this pull request Oct 3, 2024
Merged
@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Oct 3, 2024 •
edited
Loading

⚡️ Lighthouse report for the changes in this PR:

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

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

@derberg
Copy link
Member

derberg commented Oct 3, 2024

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 😉

@bandantonio bandantonio force-pushed the docs/add-missing-excerpts-to-hide-imports branch from 6e7f58b to 9fca5d8 Compare October 4, 2024 19:48
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Oct 4, 2024 •
edited
Loading

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 9fca5d8 and 4d50d1d.

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

@bandantonio
Copy link
Contributor Author

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 😎

@derberg
Copy link
Member

derberg commented Oct 9, 2024

@bandantonio and here are the conflicts 😄

@bandantonio
Copy link
Contributor Author

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

@derberg
Copy link
Member

derberg commented Oct 9, 2024

@quetzalliwrites please approve and merge

anshgoyalevil
anshgoyalevil approved these changes Nov 30, 2024
View reviewed changes
Copy link
Member

@anshgoyalevil anshgoyalevil left a comment

Choose a reason for hiding this comment

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

🚢

@akshatnema
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anshgoyalevil anshgoyalevil anshgoyalevil approved these changes

@akshatnema akshatnema akshatnema approved these changes

@thulieblack thulieblack Awaiting requested review from thulieblack thulieblack is a code owner

@quetzalliwrites quetzalliwrites Awaiting requested review from quetzalliwrites quetzalliwrites is a code owner

@devilkiller-ag devilkiller-ag Awaiting requested review from devilkiller-ag

@sambhavgupta0705 sambhavgupta0705 Awaiting requested review from sambhavgupta0705

@BhaswatiRoy BhaswatiRoy Awaiting requested review from BhaswatiRoy

@J0SAL J0SAL Awaiting requested review from J0SAL

@TRohit20 TRohit20 Awaiting requested review from TRohit20

@VaishnaviNandakumar VaishnaviNandakumar Awaiting requested review from VaishnaviNandakumar

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bandantonio @asyncapi-bot @derberg @akshatnema @anshgoyalevil