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

A documentation-specific 404 page is needed #1976

Closed
aallan opened this issue Aug 9, 2021 · 22 comments · Fixed by #2026
Closed

A documentation-specific 404 page is needed #1976

aallan opened this issue Aug 9, 2021 · 22 comments · Fixed by #2026
Assignees
Labels
enhancement linked pull request Has a linked Pull Request that will close the issue. toolchain This is an infrastructure/toolchain issue

Comments

@aallan
Copy link
Contributor

aallan commented Aug 9, 2021

I think the best solution to #1973 is that the documentation site has its own 404 page which is more helpful; perhaps having the top-level categories? This will help redirect lost users back into the main documentation rather than just stranding them with a generic "404" message.

Screenshot 2021-08-09 at 12 39 10

Any ideas what should be on this page @jackbenwillis, @mudge ?

@aallan aallan added enhancement toolchain This is an infrastructure/toolchain issue labels Aug 9, 2021
@ghost
Copy link

ghost commented Aug 9, 2021

I wonder if it would be possible to have the documentation-specific 404 page just be the documentation index page itself? You could trigger some specific error message within the page by passing a parameter as part of the URL. (Since I would expect a suitable documentation-specific 404 page to be basically just the top-level index page, with the addition of a 'not found' error).

@aallan
Copy link
Contributor Author

aallan commented Aug 10, 2021

We've now added some category level redirects (see #2010) which should catch most 404'ed pages. But a custom 404 page for the documentation is still needed I think.

@aallan
Copy link
Contributor Author

aallan commented Aug 10, 2021

@jackbenwillis Can you have a think about what this should look like?

@lurch
Copy link
Contributor

lurch commented Aug 10, 2021

@aallan
Copy link
Contributor Author

aallan commented Aug 10, 2021

https://web.archive.org/web/20140714193525/www.raspberrypi.org/404

The new 404 page should presumably direct people to the new documentation site, maybe let people search for things, and encourage them to update their dead links. Not entirely sure that helps! 😆

@jackbenwillis
Copy link

image
What about this? Replacing the header with a 404 message and asking people to browse the updated documentation. This way you'll already be on the documentation landing page and be able to get going right away

@aallan
Copy link
Contributor Author

aallan commented Aug 10, 2021

That'd work for me. Hopefully it'd be possible to configure it so that the landing page in the 404 isn't static or separately generated (and have to be updated independently from the main top page)...? @nelliemckesson @mudge ?

@mudge
Copy link
Contributor

mudge commented Aug 10, 2021

That'd work for me. Hopefully it'd be possible to configure it so that the landing page in the 404 isn't static or separately generated (and have to be updated independently from the main top page)...? @nelliemckesson @mudge ?

@nelliemckesson can confirm but I expect we can generate a separate 404 page much like we do the current index page, dynamically populating it with the same categories and even including the search functionality. I can then configure our web server to use that page whenever it encounters a 404 error rather than taking users to https://www.raspberrypi.org/404.html

@aallan
Copy link
Contributor Author

aallan commented Aug 10, 2021

Let's do it this way then.

@lurch
Copy link
Contributor

lurch commented Aug 10, 2021

@mudge I think we'd want to keep the existing generic https://www.raspberrypi.org/404.html page, and only use this new design for 404s coming from the https://www.raspberrypi.org/documentation/ "subdirectory"? Is it possible to do that?

@aallan
Copy link
Contributor Author

aallan commented Aug 10, 2021

Is it possible to do that?

I was presuming that's what he meant?

@mudge
Copy link
Contributor

mudge commented Aug 10, 2021

Yes, that's what I meant. We won't touch https://www.raspberrypi.org/404.html as that is used by other parts of the site but instead configure the documentation server specifically to use our new documentation-only 404 page.

@lurch
Copy link
Contributor

lurch commented Aug 10, 2021

Ah, sorry for getting my wires crossed 😆

@lurch
Copy link
Contributor

lurch commented Aug 10, 2021

I just knocked up a quick prototype and came up with this:
Screenshot from 2021-08-10 13-40-19

Is everyone happy enough with that for me to create a PR?

@jackbenwillis
Copy link

Could we increase the size of the '404'?

Otherwise looks good!

@lurch
Copy link
Contributor

lurch commented Aug 10, 2021

I dunno how to change font-sizes, that's a CSS thing 😆 So I'll put together a PR with what I've got and @nelliemckesson can bump the font-sizes later 👍

@lurch
Copy link
Contributor

lurch commented Aug 10, 2021

@nelliemckesson I tried making "Raspberry Pi Documentation" into a link, but it didn't look right, so I won't do that for now 😉
Screenshot from 2021-08-10 14-05-34

@aallan
Copy link
Contributor Author

aallan commented Aug 10, 2021

I tried making "Raspberry Pi Documentation" into a link, but it didn't look right, so I won't do that for now

Eek. No, that's not right. 😬

@lurch
Copy link
Contributor

lurch commented Aug 10, 2021

See #2026

@aallan aallan added the linked pull request Has a linked Pull Request that will close the issue. label Aug 10, 2021
@jackbenwillis
Copy link

jackbenwillis commented Aug 10, 2021

Yup! leave it out for now ;)

small thing, full stop after for and uppercase P in please (all my fault)!

"We couldn't find what you were looking for. Please browse our updated Raspberry Pi Documentation."

@jackbenwillis
Copy link

and a full stop!

@aallan aallan linked a pull request Aug 12, 2021 that will close this issue
@aallan
Copy link
Contributor Author

aallan commented Aug 12, 2021

@nelliemckesson If you could look at #2026 and sprinkle some CSS magic that'd be great! Thanks!

aallan pushed a commit that referenced this issue Aug 13, 2021
Add tooling to create a 404 page. Partially fixes #1976
davidplowman pushed a commit to davidplowman/documentation that referenced this issue Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement linked pull request Has a linked Pull Request that will close the issue. toolchain This is an infrastructure/toolchain issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants