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

docs: Broken link to Generator Github Actions(#3190) #3299

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

TanmayChaurasia24
Copy link

@TanmayChaurasia24 TanmayChaurasia24 commented Oct 17, 2024

Changed markdown/docs/tools/generator/installation-guide.md
Resolves #3190
now

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions for the AsyncAPI CLI and generator library for improved clarity and accuracy.
    • Revised note on using the generator in CI/CD pipelines, emphasizing GitHub Actions integration with a new link.

Copy link

coderabbitai bot commented Oct 17, 2024

Walkthrough

The changes made in the pull request focus on updating the installation instructions for the AsyncAPI CLI and generator library. The document's content has been revised for clarity, specifically enhancing the note regarding the use of the generator in CI/CD pipelines. The link to GitHub Actions has been corrected to reflect the new URL, which provides broader functionality. The overall structure and formatting remain intact, ensuring clear accessibility of prerequisites and installation instructions.

Changes

File Path Change Summary
markdown/docs/tools/generator/installation-guide.md Updated link in CI/CD pipeline note to the correct GitHub Actions page; content revised for clarity.

Assessment against linked issues

Objective Addressed Explanation
Update broken link to Generator GitHub Actions (#3190)

Poem

🐰 In the garden where links once broke,
A new path blooms, a clearer stroke.
With AsyncAPI's guide, we hop with glee,
GitHub Actions now work, as they should be!
Hooray for updates, let’s celebrate,
With every change, our docs are great! 🌼


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 17, 2024

Deploy Preview for asyncapi-website failed.

Built without sensitive environment variables

Name Link
🔨 Latest commit 48d7e68
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6711628a9919ca00083cde6d

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Oct 17, 2024

We require all PRs to follow Conventional Commits specification.
More details 👇🏼

 The subject "Broken link to Generator Github Actions(#3190)" found in the pull request title "docs: Broken link to Generator Github Actions(#3190)" should start with a lowercase character.

Copy link

@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

🧹 Outside diff range and nitpick comments (1)
markdown/docs/tools/generator/installation-guide.md (1)

76-76: Approved: Link updated successfully.

The change successfully addresses the issue of the broken link to GitHub Actions for Generator. The new link is more comprehensive and accurately reflects the expanded functionality of the GitHub Action.

Consider adding a brief description of the additional features included in the new GitHub Action (validator, converter, etc.) to give users a better understanding of its capabilities. For example:

> :memo: **Note:** To use the generator in your CI/CD pipeline to automate whatever you generate for your event-driven architecture apps, install the AsyncAPI CLI in your pipeline. If you are using GitHub Actions, use [Github Actions for Generator](https:/marketplace/actions/generator-validator-converter-and-others-all-in-one-for-your-asyncapi-docs), which includes additional features like validation and conversion for your AsyncAPI documents.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7abb5fd and 48d7e68.

📒 Files selected for processing (1)
  • markdown/docs/tools/generator/installation-guide.md (1 hunks)
🧰 Additional context used

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.

[Docs Bug 🐞 report]: Broken link to Generator Github Actions
3 participants