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 Bug 🐞 report]: Links to GitHub are incorrect #3067

Open
1 task done
andrew-rosca opened this issue Jul 1, 2024 · 6 comments
Open
1 task done

[Docs Bug 🐞 report]: Links to GitHub are incorrect #3067

andrew-rosca opened this issue Jul 1, 2024 · 6 comments

Comments

@andrew-rosca
Copy link
Contributor

Describe the bug you found in AsyncAPI Docs.

The links at the top of every docs page point to the incorrect path at GitHub

For example, on this page: https://www.asyncapi.com/docs/concepts/asyncapi-document/securing-operations
image
the link points to https://github.com/asyncapi/website/blob/master/pages/docs/concepts/asyncapi-document/securing-operations.md

The correct link is actually https://github.com/asyncapi/website/blob/master/markdown/docs/concepts/asyncapi-document/securing-operations.md

(i.e. pages should be markdown in the path)

The bug is most likely in the generateEditLink function, though I can't immediately spot it

Attach any resources that can help us understand the issue.

see info in description

Code of Conduct

  • I agree to follow this project's Code of Conduct
Copy link

github-actions bot commented Jul 1, 2024

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

@DhairyaMajmudar
Copy link
Contributor

Hi @derberg I would like to open a PR for this issue

@sambhavgupta0705
Copy link
Member

@anshgoyalevil should we setup a GitHub action for this or only changing the config file will work

@anshgoyalevil
Copy link
Member

IMHO, we should first try with the config file way, and if there's no appropriate solution with that, we can go with a GitHub Action

@Vradash
Copy link

Vradash commented Jul 20, 2024

I would like to work on this issue can you assign it to me?
Also should I redirect the link to to the github code file of the docs/concepts page or to the link mentioned in the description

@sambhavgupta0705
Copy link
Member

closing this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants