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 docs custom 404 page and reword messaging #8415

Merged
merged 1 commit into from
Sep 28, 2020
Merged

Fix docs custom 404 page and reword messaging #8415

merged 1 commit into from
Sep 28, 2020

Conversation

yzdocs
Copy link
Contributor

@yzdocs yzdocs commented Sep 16, 2020

Fixes #4908 and #8076.

The custom 404 image is a stretch goal so I haven't attempted it with this PR.

Please preview the new 404 page here: https://deploy-preview-8415--cockroachdb-docs.netlify.app/docs/stable/404.html

You will not be able to see the page above by going to a broken link via preview site, because the way Netlify redirects, it will send you from a preview broken link to the 404 page in production. But you can use the Netlify preview site to verify that broken links are being redirected to the 404 page in production, which is an improvement over current behavior (see #4908).

I think this is one PR that we should make live immediately instead of waiting for all style updates. This is because the current 404 functionality is broken (see #4908), so we are essentially fixing a bug that affects users today.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@yzdocs yzdocs force-pushed the 404 branch 2 times, most recently from c1a1495 to 29208ec Compare September 16, 2020 21:37
@cockroach-teamcity

This comment has been minimized.

@cockroach-teamcity

This comment has been minimized.

@cockroach-teamcity

This comment has been minimized.

@yzdocs yzdocs changed the title Fix docs 404 page and reword messaging Fix docs custom 404 page and reword messaging Sep 16, 2020
Copy link
Contributor

@jseldess jseldess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Thanks, @yingzhuchin!

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @anagio, @jseldess, @lnhsingh, and @luciaaaaaaa)

Copy link
Contributor

@lnhsingh lnhsingh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm: and I agree that it makes sense to push this one live

Reviewable status: :shipit: complete! 2 of 0 LGTMs obtained (waiting on @anagio, @lnhsingh, and @luciaaaaaaa)

@luciaaaaaaa
Copy link

Wondering if we want to add the 'Return to home' button, as a way for the user to have a clear action to take from here. Otherwise, lgtm!

@yzdocs
Copy link
Contributor Author

yzdocs commented Sep 23, 2020

Wondering if we want to add the 'Return to home' button, as a way for the user to have a clear action to take from here. Otherwise, lgtm!

I think since the search bar, sidebar, and top navigation bar are all still accessible on the 404 page, the user should be good on what to do next. My two cents!

@yzdocs
Copy link
Contributor Author

yzdocs commented Sep 28, 2020

I'll merge this for now since I'm shifting focus, but we can add any additional asks to #8082 and pick up from there!

@yzdocs yzdocs closed this Sep 28, 2020
@yzdocs yzdocs reopened this Sep 28, 2020
@yzdocs yzdocs merged commit 28133d5 into master Sep 28, 2020
@yzdocs yzdocs deleted the 404 branch September 28, 2020 14:10
@yzdocs yzdocs linked an issue Sep 28, 2020 that may be closed by this pull request
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.

Error page: 404 messaging Docs 404 page not working
5 participants