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

Quickstart page has two dead links at the bottom for the heading Next Steps #481

Closed
patterns opened this issue Mar 17, 2023 · 9 comments
Closed

Comments

@patterns
Copy link

The two "Learn" links go to the not-found page while the third cloud link works. The sidebar nav has both destinations available and working (/spin/writing-apps, /spin/build) and inspecting the working cloud link in the raw file, it shows /cloud/quickstart while the other two are relative.

@itowlson
Copy link
Contributor

Sorry about this and thanks for letting us know; I see the same thing.

@tpmccallum @karthik2804 As far as I can tell, the links in quickstart.md are formatted in the same way as, say, build.md, but the latter work and the former don't. They also work when running locally, which is why the link checker doesn't pick them up. But on the production site they have the extra bit of path. Any idea what could cause this?

@tpmccallum
Copy link
Contributor

Thanks @patterns
Will have this fixed asap.
https://github.com/fermyon/developer/pull/482/files

@karthik2804
Copy link
Contributor

karthik2804 commented Mar 17, 2023

@itowlson I suspect this is some browser-specific behavior. It works as expected on chrome windows and android for me.

image

The issue is due to the trailing slash at the end of quickstart (e.g) https://developer.fermyon.com/spin/quickstart/.

@itowlson
Copy link
Contributor

Aha, that makes sense - I just tried quickstart and it suddenly fixed itself.

@karthik2804
Copy link
Contributor

We should possibly not use relative URLs with the factor of a trailing slash existing.

@tpmccallum
Copy link
Contributor

My understanding, whilst testing this, is that if a user is visiting a page and have a trailing slash in the URL i.e. https://developer.fermyon.com/spin/quickstart/ (as opposed to no trailing slash i.e. https://developer.fermyon.com/spin/quickstart) then clicking relative URLs on that specific page will result in "Not Found" errors for the user.

@karthik2804 with your knowledge about this:

  • Is the fix to always use absolute URLs in documentation? If so we will need to write something in the lint process that does not allow relative URLs in markdown files.
  • Is the fix to update how Bartholomew processes relative URLs? (I think there might be an upcoming Bartholomew .wasm upgrade that covers this right?)

Many thanks
Tim

@karthik2804
Copy link
Contributor

One solution is to always use absolute URLs but there is a solution proposed in Bartholomew which will potentially fix this issue.

@itowlson
Copy link
Contributor

itowlson commented May 11, 2023

Can we bump up the priority of the Bartholomew work please because using absolute URLs in the Markdown is not a solution.

image

@tpmccallum
Copy link
Contributor

Fixed by #616

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

No branches or pull requests

4 participants