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

fix(link): fixing github redirecting links #3071

Closed
wants to merge 13 commits into from

Conversation

DhairyaMajmudar
Copy link
Contributor

Description

  • Fixed the edit-page-config.json file to fix the issue
  • changed page in the href key to markdown

Related issue(s)
Fixes #3067

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.

Copy link

netlify bot commented Jul 2, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e4429f8
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/66d84df87ebe9d00081c6b37
😎 Deploy Preview https://deploy-preview-3071--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.

@DhairyaMajmudar DhairyaMajmudar changed the title fix(link): fixinf gh redirecting links fix(link): fixing github redirecting links Jul 2, 2024
@DhairyaMajmudar
Copy link
Contributor Author

@akshatnema dunno why Lighthouse CI is failing even for small change is there any way to fix ?

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Jul 10, 2024

⚡️ 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-3071--asyncapi-website.netlify.app/

@anshgoyalevil
Copy link
Member

Thanks for the change, @DhairyaMajmudar. Can you please dig into the issue further as I just found out some other docs edit links are broken. For example: https://www.asyncapi.com/docs/tools/generator/asyncapi-document link should have an edit link to https://github.com/asyncapi/generator/blob/master/apps/generator/docs/asyncapi-document.md but is instead https://github.com/asyncapi/generator/tree/master/docs/asyncapi-document.mdx which is wrong.
There might be other such links, which you would need to find out.

@DhairyaMajmudar
Copy link
Contributor Author

Thanks for the change, @DhairyaMajmudar. Can you please dig into the issue further as I just found out some other docs edit links are broken. For example: https://www.asyncapi.com/docs/tools/generator/asyncapi-document link should have an edit link to https://github.com/asyncapi/generator/blob/master/apps/generator/docs/asyncapi-document.md but is instead https://github.com/asyncapi/generator/tree/master/docs/asyncapi-document.mdx which is wrong. There might be other such links, which you would need to find out.

Sure thing 👍🏻

@sambhavgupta0705
Copy link
Member

@DhairyaMajmudar just check all the links and report them here after that have we can see that need to change only the config or the gh action ferentor '

@DhairyaMajmudar
Copy link
Contributor Author

DhairyaMajmudar commented Jul 11, 2024

Hi, @anshgoyalevil @sambhavgupta0705 I checked the links and did the needy changes in config files but the bug still exists since the links generated redirects to .mdx files instead of .md

The reason behind is their declaration in the posts.json file but since it is mentioned in .gitignore I am not able to commit the changes in that file.

EDIT: Also its a bit strange how I'm able to access the files mentioned in .gitignore

@DhairyaMajmudar
Copy link
Contributor Author

DhairyaMajmudar commented Jul 25, 2024

Hi, @anshgoyalevil @sambhavgupta0705 I checked the links and did the needy changes in config files but the bug still exists since the links generated redirects to .mdx files instead of .md

The reason behind is their declaration in the posts.json file but since it is mentioned in .gitignore I am not able to commit the changes in that file.
EDIT: Also its a bit strange how I'm able to access the files mentioned in .gitignore

@sambhavgupta0705 just a friendly ping on this.

@sambhavgupta0705
Copy link
Member

@derberg we need your suggestion here

@derberg
Copy link
Member

derberg commented Aug 21, 2024

you also need to update the component responsible for edit link: https://github.com/asyncapi/website/blob/master/components/layout/DocsLayout.tsx#L53

@akshatnema
Copy link
Member

@DhairyaMajmudar any updates on the PR?

@DhairyaMajmudar
Copy link
Contributor Author

@DhairyaMajmudar any updates on the PR?

I'm still unsure of this #3071 (comment)

@DhairyaMajmudar
Copy link
Contributor Author

@akshatnema @sambhavgupta0705 I've fixed the problem stated in #3071 (comment) now links are working as expected, can you pls. review the PR.

@sambhavgupta0705
Copy link
Member

@DhairyaMajmudar

add config for glee docs

@sambhavgupta0705
Copy link
Member

closing this one as we have changed the scope of the issue

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]: Links to GitHub are incorrect
6 participants