octobercms/docs

Broken links in the doc's section

Closed this issue · 8 comments

Will slowly go through and explain each one.

URL: https://octobercms.com/docs/api/backend/widgets/table

image

Change to URL: https://jsperf.com/performance-of-array-vs-object/3


URL: https://octobercms.com/docs/api/october/rain/database/readme

image

No such file in this repo! Admins to look deeper please.


URL: https://octobercms.com/docs/api/october/rain/support/readme

image

No such file in this repo! Admins to look deeper please.


URL: https://octobercms.com/docs/cms/pages/

image

image

image

image

image

Problem with the coding.


URL: https://octobercms.com/docs/help/using-composer

image

image

Correct these two, please


URL: https://octobercms.com/docs/services/queues

image


p.s. Links in orange or yellow are 404.

Thanks.

@ayumi-cloud Have you confirmed these reports? Upon inspection, most of these links appear to be working fine

@daftspunk All the ones I have posted, I have personally checked and confirmed.

I'm guessing the https://octobercms.com/docs/cms/pages/ has the same issue, I found in this issue: #392

I can demo the error in a third testing tool, see gif:

ezgif-5-ff37afb66fb1

clearer screenshot:

image

I mean, have you opened the website in a browser and clicked the link yourself

https://octobercms.com/docs/cms/pages/ redirects to https://octobercms.com/docs/cms/pages which does not have this problem

@daftspunk yes, have opened all the links in a browser myself.

I give you examples so we are on same page.

Link Result
(main) https://octobercms.com/docs/cms/pages/ 200
(ToC) https://octobercms.com/docs/cms/pages/#introduction 200
(Internal) https://octobercms.com/docs/cms/pages/themes#php-section 400

image

another example

image

etc.

@ayumi-cloud The links work for me just fine, but I think I see where the issue might lie.

The PHP section link you reported above as a 404 has the following HTML: <a href="themes#php-section">PHP section</a>. It's possible that your link scanner is appending the themes as a new segment at the end of the URL, as opposed to overwriting the last segment.

Instead of https://octobercms.com/docs/cms/pages/themes#php-section, it should be https://octobercms.com/docs/cms/themes#php-section

@bennothommo If it was purely the link scanner as the issue that would be cool, the trouble is that I'm copying the links and if I click on those links in my browser I get the same error.

Yes the error is:

Instead of https://octobercms.com/docs/cms/pages/themes#php-section, it should be https://octobercms.com/docs/cms/themes#php-section

Surely that's a rewrite issue in the redirects somewhere?


Also don't forget there are other types of 404 errors I have listed above e.g.

URL: https://octobercms.com/docs/api/october/rain/support/readme

image

Gives me a link of: https://github.com/octobercms/docs/blob/master/advanced-console.md

Which results in a 404.


URL: https://octobercms.com/docs/api/october/rain/support/readme

I have just noticed there is another coding issue on that web page as well.

image

another screenshot of same web page:

image

Notice the header sizes getting smaller and smaller due to an open <code> tag wrapping the header and text etc.

@bennothommo If it was purely the link scanner as the issue that would be cool, the trouble is that I'm copying the links and if I click on those links in my browser I get the same error.

Yes the error is:

Instead of https://octobercms.com/docs/cms/pages/themes#php-section, it should be https://octobercms.com/docs/cms/themes#php-section

Surely that's a rewrite issue in the redirects somewhere?

@ayumi-cloud I don't believe that's the case - what I meant in my original post was that I traversed the docs pages as you said, and clicked the links you pointed to, and they worked. Yes, the URL you listed above showed a 404, but unless I am clicking the wrong link somewhere, I never got that URL through normal navigation of the docs.

Also don't forget there are other types of 404 errors I have listed above e.g.

URL: https://octobercms.com/docs/api/october/rain/support/readme

Gives me a link of: https://github.com/octobercms/docs/blob/master/advanced-console.md

Which results in a 404.

You're correct here though - the link there is definitely incorrect.

URL: https://octobercms.com/docs/api/october/rain/support/readme

I have just noticed there is another coding issue on that web page as well.

another screenshot of same web page:

Notice the header sizes getting smaller and smaller due to an open <code> tag wrapping the header and text etc.

Would you mind moving this reported issue into its own issue on GitHub just so we don't conflate different issues in the same report?

@bennothommo

Would you mind moving this reported issue into its own issue on GitHub just so we don't conflate different issues in the same report?

No problem, will do that now for you.