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: fix link to example asyncapi document #574

Merged
merged 4 commits into from
Jun 13, 2024
Merged

docs: fix link to example asyncapi document #574

merged 4 commits into from
Jun 13, 2024

Conversation

1p22geo
Copy link
Contributor

@1p22geo 1p22geo commented Jun 7, 2024

Description

  • the link in README.md refers to an old filename - the example YAML file in asyncapi/spec has been renamed.
  • also make it more clear that the link is an example of an AsyncAPI document

Old link: https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka.yml
New link: https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka-asyncapi.yml

Related issue(s)
none yet

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.

@1p22geo 1p22geo changed the title patch: fix the 404 link patch: fix the example link Jun 7, 2024
@1p22geo
Copy link
Contributor Author

1p22geo commented Jun 7, 2024

all right, conventional commits, I get it. Renamed the commit from patch: to fix:

@1p22geo 1p22geo changed the title patch: fix the example link fix(README.md): patched the example link Jun 7, 2024
README.md Outdated Show resolved Hide resolved
Co-authored-by: Lukasz Gornicki <[email protected]>
@1p22geo
Copy link
Contributor Author

1p22geo commented Jun 13, 2024

I'm not really strong on accessibility, but I guess that makes sense...

@derberg derberg changed the title fix(README.md): patched the example link docs: fix link to example asyncapi document Jun 13, 2024
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

changed prefix as we do not need to provide a release artefact for readme update

thanks for the fix!

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@derberg
Copy link
Member

derberg commented Jun 13, 2024

/rtm

@asyncapi-bot asyncapi-bot merged commit 74b2f47 into asyncapi:master Jun 13, 2024
10 checks passed
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 1.6.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

3 participants