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

Some documentation is gone from the website. #1488

Closed
michalz92 opened this issue Sep 11, 2019 · 7 comments · Fixed by #1489 or #1494
Closed

Some documentation is gone from the website. #1488

michalz92 opened this issue Sep 11, 2019 · 7 comments · Fixed by #1489 or #1494
Labels
bug Something isn't working

Comments

@michalz92
Copy link

Some core documentation has disappeared (or has been moved?) from the website. Maybe it's just the guide that was deleted, but I have too few examples to know. Here are two:

https://docs.prefect.io/guide/core_concepts/notifications.html
https://docs.prefect.io/guide/examples/state_handler_logging.html

@michalz92 michalz92 added the bug Something isn't working label Sep 11, 2019
@joshmeek
Copy link

The docs previously under /guide/ were moved to /core/ (also w/ core_concepts being renamed concepts. Were there any places in the docs that these /guide/ absolute links were used?

@jlowin
Copy link
Member

jlowin commented Sep 11, 2019

I think we can add redirects for the old links: vuejs/vuepress#239 (comment)

@michalz92
Copy link
Author

I didn't find any such examples, but you use the old links in your Medium posts and some top google search results.

@jlowin
Copy link
Member

jlowin commented Sep 11, 2019

@znicholasbrown if you have a moment, would appreciate your expertise here. In the local development server, these redirects worked, but in the built/deployed site they aren't working.

Dev

http://localhost:8081/guide/core_concepts/parameters.html
redirects properly to
http://localhost:8081/core/concepts/parameters.html

Deployed

https://docs.prefect.io/guide/core_concepts/parameters.html
redirects to the correct URL in the browser (https://docs.prefect.io/core/concepts/parameters.html), but renders the page at https://docs.prefect.io

If I hit refresh, then I get the correct page.

I'm sure I've made a mistake somewhere...

@jlowin jlowin reopened this Sep 11, 2019
@znicholasbrown
Copy link
Contributor

znicholasbrown commented Sep 11, 2019

@jlowin so the problem here is that we're generating static docs as opposed to a SPA (which is what's running in the dev environment) - no router is actually matching these dynamic routes, since there shouldn't BE dynamic routes; all of the pages have to be rendered ahead of time. There's a community plugin (https://vuepress.github.io/en/plugins/redirect/#usage) that's supposed to bridge that gap by generating the dynamic routes but I haven't had much luck with it.

This is a known issue, tracked here: vuejs/vuepress#160
which is supposedly resolved here:
vuepress/vuepress-plugin-redirect#1

For now, I think setting up the redirects through netlify is the most expedient solution.

@jlowin
Copy link
Member

jlowin commented Sep 11, 2019

Thanks @znicholasbrown, will do asap.

@cicdw
Copy link
Member

cicdw commented Sep 12, 2019

Confirmed: the redirects are working and the above links are back in business - thanks @jlowin and @znicholasbrown !

zanieb pushed a commit that referenced this issue Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
5 participants