openrewrite / rewrite

Automated mass refactoring of source code.
https://docs.openrewrite.org
Apache License 2.0
2.03k stars 300 forks source link

Most documention links do not work #1496

Closed yeikel closed 2 years ago

yeikel commented 2 years ago

Most of them do not work but some work occasionally

In this case in particular, the issue is that all links point to https://docs.openrewrite.org/reference/recipes/java/testing/junit5 instead of the specific pages

Sample page : https://docs.openrewrite.org/reference/recipes/java/testing/junit5

tkvangorder commented 2 years ago

Thanks for reporting, we have a tool that generates these docs, clearly, something is amiss. 8)

tkvangorder commented 2 years ago

This appears to be a syncing issue between when the rewrite-docs repository to docs.rewrite.org. The links are now working but we will keep an eye on this for our next release.

yeikel commented 2 years ago

Is docs.rewrite.org a future work? Because that does not return anything for me

okundzich commented 2 years ago

Tyler meant https://docs.openrewrite.org/. We opened an issue with gitbook (tool that we are using for docs) as it is not refreshing the links from the docs git repo. https://github.com/openrewrite/rewrite-docs/tree/master/reference/recipes/java/testing/junit5

yeikel commented 2 years ago

Tyler meant https://docs.openrewrite.org/. We opened an issue with gitbook (tool that we are using for docs) as it is not refreshing the links from the docs git repo. https://github.com/openrewrite/rewrite-docs/tree/master/reference/recipes/java/testing/junit5

Thank you. It seems that I am better off using the docs from this repo until that's fixed

tkvangorder commented 2 years ago

@yeikel Sorry for the confusion, yes the correct URL for our docs is https://docs.openrewrite.org/

I have once again generated the documentation and I believe it is now working.

One thing to notice, at the bottom of each category page, is a timestamp of when the page was last modified.

image

I have found a couple of cases where my browser was caching an older version of the page. In chrome, I just use shift+reload to force the page to reload. This may be part of the problem.

tkvangorder commented 2 years ago

I have confirmed that the links are now working after regenerating the recipe references again.

yeikel commented 2 years ago

I have confirmed that the links are now working after regenerating the recipe references again.

They're working

Thanks