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

Documentation pages are down #2608

Open
jbotuck opened this issue Sep 7, 2022 · 15 comments
Open

Documentation pages are down #2608

jbotuck opened this issue Sep 7, 2022 · 15 comments

Comments

@jbotuck
Copy link

jbotuck commented Sep 7, 2022

Describe the issue
readme.md references https://jdbc.postgresql.org/documentation/head/ which is returning 404 for me. Half the doc links returned by google are returning 404

To Reproduce
Steps to reproduce the behaviour:
hit https://jdbc.postgresql.org/documentation/head/ in a browser

Expected behaviour
page loads with status of 200

@davecramer
Copy link
Member

@davecramer
Copy link
Member

Readme has been updated. Which pages are missing ?

@davecramer
Copy link
Member

This is sort of a soft launch of our new website. Thanks for finding the bug so fast :)

@jbotuck
Copy link
Author

jbotuck commented Sep 7, 2022

where's the javadoc?

@jbotuck
Copy link
Author

jbotuck commented Sep 7, 2022

https://jdbc.postgresql.org/documentation/reading/ has a link to docs for further reading. The link is less than helpful

@jbotuck
Copy link
Author

jbotuck commented Sep 7, 2022

https://jdbc.postgresql.org/index.html has a link on the bottom to publicapi which returns 404

@davecramer
Copy link
Member

https://jdbc.postgresql.org/index.html has a link on the bottom to publicapi which returns 404

fixed

@davecramer
Copy link
Member

https://jdbc.postgresql.org/documentation/reading/ has a link to docs for further reading. The link is less than helpful

Yes, saw that... thanks

@davecramer davecramer reopened this Sep 7, 2022
@jbotuck
Copy link
Author

jbotuck commented Sep 7, 2022

Also, consider somehow taking all the old links that are now returning 404, and turn them into redirects. You might be able to unbreak Google and stack overflow links

@davecramer
Copy link
Member

Also, consider somehow taking all the old links that are now returning 404, and turn them into redirects. You might be able to unbreak Google and stack overflow links

Interesting... Might be able to do it on the site, but not individual links

@ianjevans
Copy link

Another vote to add at least site-level redirects when totally refactoring your docs pages. The CockroachDB docs have a fair number of links into your docs that we recently discovered are now broken.

@davecramer
Copy link
Member

Feel free to provide me with a PR.

@ianjevans
Copy link

I don't know your publishing pipeline or deployment environment for your doc site. That level of configuration is not checked into this code repo anyway, so even if I engaged with your suggestion at face value I wouldn't be able to proceed.

I see on Twitter that you were upset about my comment, which was intended to help external users of your docs find the info that they need, NOT to fix our own docs. Broken links from non-commercial blog posts, forum posts, Stack Exchange questions, Reddit threads, etc. are bigger issues when refactoring docs, because there's nobody to get paid to go and fix broken links, unlike our commercial docs.

@ianjevans
Copy link

As I said, I can't give you a PR, but I did take a little time to write these permanent redirect rules for you on the off chance you use Apache and mod_rewrite. I tested them with an htaccess tester. These were based on our own fixes to our commercial docs, but this might help others in the larger PostgreSQL ecosystem, I dunno.

RewriteRule "^documentation/head/connect.html" "/documentation/use/" [R=301,L]
RewriteRule "^documentation/head/query.html" "/documentation/query/" [R=301,L]
RewriteRule "^documentation/head/setup.html" "/documentation/setup/" [R=301,L]
RewriteRule "^documentation/head/ds-ds.html" "/documentation/datasource/" [R=301,L]
RewriteRule "^documentation/head/index.html" "/documentation/" [R=301,L]

@davecramer
Copy link
Member

OK, so the simplest way is to use hugo redirects.

@davecramer davecramer reopened this Jan 9, 2023
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

3 participants