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

External link is broken in Native Build Tips documentation page #34929

Closed
gian1200 opened this issue Jul 21, 2023 · 10 comments · Fixed by #35795
Closed

External link is broken in Native Build Tips documentation page #34929

gian1200 opened this issue Jul 21, 2023 · 10 comments · Fixed by #35795
Labels
area/documentation kind/bug Something isn't working
Milestone

Comments

@gian1200
Copy link
Contributor

gian1200 commented Jul 21, 2023

Describe the bug

The link at https://quarkus.io/version/main/guides/writing-native-applications-tips#managing-proxy-classes is broken.

Current link: https://www.graalvm.org/jdk-17/reference-manual/native-image/guides/configure-dynamic-proxies/

Found:

Caveat:
It is possible that the link will break in the future if GraalVM docs structure changes again.

Expected behavior

External link should load.

Actual behavior

External link doesn't load

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

No response

GraalVM version (if different from Java)

No response

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

SRC: https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/writing-native-applications-tips.adoc

@gian1200 gian1200 added the kind/bug Something isn't working label Jul 21, 2023
@gian1200 gian1200 changed the title External link is broken in Native Build Tips documentaiton page External link is broken in Native Build Tips documentation page Jul 21, 2023
@gian1200
Copy link
Contributor Author

I was trying to do a PR, but the link is referencing a graalvm-version variable.
https://www.graalvm.org/%7Bgraalvm-version%7D/reference-manual/native-image/dynamic-features/Reflection/.

Not sure where it is defined or even if it should be changed or a different variable should be used (or replaced with latest)

@geoand
Copy link
Contributor

geoand commented Jul 24, 2023

Not sure where it is defined or even if it should be changed or a different variable should be used (or replaced with latest)

The docs intentionally mention a specific GraalVM (same with other tools like Maven).

@geoand
Copy link
Contributor

geoand commented Jul 24, 2023

But indeed in this case GraalVM doesn't seem to have those docs in any other place other than latest...
cc @gsmet @zakkak

@zakkak
Copy link
Contributor

zakkak commented Jul 24, 2023

Yes, I guess that's due to the transition from the old GraalVM versioning to the new "JDK versioning".

@alina-yur is there a fixed link (like jdk-17 or similar) for latest, like it used to for 22.3, etc.?

We don't want our docs to point to latest, as Quarkus has versioned docs and older versions might need to reference older GraalVM docs.

@alina-yur
Copy link

alina-yur commented Jul 24, 2023

hi @zakkak. Indeed we should have links for jdk 17 & jdk 20; right now this content is under /latest/, but latest will change. We will work on this, thanks for the ping.

@geoand
Copy link
Contributor

geoand commented Jul 24, 2023

Thanks @alina-yur!

@zakkak
Copy link
Contributor

zakkak commented Jul 24, 2023

hi @zakkak. Indeed we should have links for jdk 17 & jdk 20; right now this content is under /latest/, but latest will change. We will work on this, thanks for the ping.

Thank you for the prompt reply @alina-yur, please let us know once there is a change.

@alina-yur
Copy link

hi @zakkak, we now have https://www.graalvm.org/jdk17/docs/ & https://www.graalvm.org/jdk20/docs/ URLs (thank you @olyagpl). There will also be jdk21 links alongside latest once that is released.

@geoand
Copy link
Contributor

geoand commented Sep 1, 2023

Thanks @alina-yur!

@zakkak it seems like we would need to update our adoc to include this version for the GraalVM docs links instead of what we have now (which is jdk-17)

@zakkak
Copy link
Contributor

zakkak commented Sep 4, 2023

Thank you @alina-yur and @olyagpl!

Correct, ideally we would do this programmatically by removing the - from the graalvm-version variable. Any ideas how we can achieve this in asciidoc?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation kind/bug Something isn't working
Projects
Development

Successfully merging a pull request may close this issue.

4 participants