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

Update what-it-do.md - fixed broken links #352

Closed
wants to merge 1 commit into from

Conversation

Remzi1993
Copy link
Contributor

Fixed broken links

Copy link

netlify bot commented Mar 17, 2025

Deploy Preview for lando-core failed. Why did it fail? →

Name Link
🔨 Latest commit 4f5fc05
🔍 Latest deploy log https://app.netlify.com/sites/lando-core/deploys/67d836bf4fa2f4000822ba0f

@Remzi1993
Copy link
Contributor Author

Remzi1993 commented Mar 18, 2025

@pirog @reynoldsalec @AaronFeledy Could someone please take a look at my PR? I noticed some broken links while reading through https://docs.lando.dev/getting-started/what-it-do.html and decided to fix them.

The changes are simple, just updating outdated URLs from /config to /landofile on that page.

@pirog
Copy link
Member

pirog commented Mar 25, 2025

@Remzi1993 its not passing the internal dead link checker: https://app.netlify.com/sites/lando-core/deploys/67d836bf4fa2f4000822ba0f

@Remzi1993
Copy link
Contributor Author

Remzi1993 commented Mar 25, 2025

@Remzi1993 its not passing the internal dead link checker: https://app.netlify.com/sites/lando-core/deploys/67d836bf4fa2f4000822ba0f

I see, but you have broken links on that page, look for yourself: https://docs.lando.dev/getting-started/what-it-do.html
And all those broken links can be fixed with a search and replace of /config to /landofile

And after changing those links I clicked on preview on all the links to double check.

So I think there is something wrong with your dead link checker, because with absolute certainty there are dead links (broken links) on that page, which you can verify yourself.

Edit: The first link you encounter on that page is broken: https://docs.lando.dev/config

Should be: https://docs.lando.dev/landofile

@pirog
Copy link
Member

pirog commented Mar 25, 2025

its not going to build the site if you dont resolve the error that i posted. the internal dead link checker is deployed on like every vitepress site on the internet so im pretty sure that is not the issue.

@Remzi1993
Copy link
Contributor Author

Remzi1993 commented Mar 25, 2025

its not going to build the site if you dont resolve the error that i posted. the internal dead link checker is deployed on like every vitepress site on the internet so im pretty sure that is not the issue.

Could you please look at that page and verify it yourself? I'm not making things up or anything, there are broken links. See: https://docs.lando.dev/getting-started/what-it-do.html

I can see this is a formatting issue: ./%5Bhttps://docs.lando.dev/landofile/services.html%5D(https://docs.lando.dev/landofile/services.html)

For some reason %5D is added, maybe because I did that quick and dirty on the GitHub website those edits. I think this is an easy fix to just remove those invisible formatting or something. See: https://stackoverflow.com/questions/9966053/what-does-5b-and-5d-in-post-requests-stand-for

@pirog
Copy link
Member

pirog commented Mar 25, 2025

i believe you and i dont think you are making things up. that said im not going to merge a PR that cannot even build the docs. if the change causes the docs to not build correctly then whatever you may or may not have fixed will never be deployed anyway so fixing that is important.

@Remzi1993
Copy link
Contributor Author

i believe you and i dont think you are making things up. that said im not going to merge a PR that cannot even build the docs. if the change causes the docs to not build correctly then whatever you may or may not have fixed will never be deployed anyway so fixing that is important.

Could you please fix those invisible formatting or commit a change to those links yourself? Cloning the whole project and making a PR is a little bit much for some broken links in the docs. Now you know the broken links and you should be easy to fix it yourself I think.

pirog added a commit that referenced this pull request Mar 25, 2025
@pirog
Copy link
Member

pirog commented Mar 25, 2025

@Remzi1993 see 6e39008

did not require pulling down the whole site although for the time we spent back and forth-ing in here you could have! ;) i just asked the AI to find something wrong with the link that was flagged in the broken build i linked you to earlier.

i appreciate that you are trying to help out but if you arent willing to take the PR all the way or you arent going to take the advice and recommendations of what you need to fix from the maintainers then we are probably going to be hesitant to jump on any further PRs.

@pirog pirog closed this Mar 25, 2025
@pirog
Copy link
Member

pirog commented Mar 25, 2025

That all said, your commit has been credited over here: #355

@Remzi1993
Copy link
Contributor Author

@Remzi1993 see 6e39008

did not require pulling down the whole site although for the time we spent back and forth-ing in here you could have! ;) i just asked the AI to find something wrong with the link that was flagged in the broken build i linked you to earlier.

i appreciate that you are trying to help out but if you arent willing to take the PR all the way or you arent going to take the advice and recommendations of what you need to fix from the maintainers then we are probably going to be hesitant to jump on any further PRs.

Very understandable. No problem 👍😅

@pirog
Copy link
Member

pirog commented Mar 25, 2025

much appreciated!!!

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.

2 participants