Skip to content

Conversation

KohiiTM
Copy link

@KohiiTM KohiiTM commented Aug 15, 2025

  • Lead with container-based builds requiring only Docker/Podman
  • Move intimidating prerequisites (C development environment) to later section
  • Keep initial prerequisites short and focused
  • Reorganize content to be more beginner-friendly while preserving all technical details

  - Lead with container-based builds requiring only Docker/Podman
  - Move intimidating prerequisites (C development environment) to later section
  - Keep initial prerequisites short and focused
  - Reorganize content to be more beginner-friendly while preserving all technical details

  Fixes quarkusio#49398
@KohiiTM KohiiTM changed the title docs: restructure native executable guide for better accessibility Restructure native executable guide for better accessibility Aug 15, 2025

This comment has been minimized.

Copy link

github-actions bot commented Aug 15, 2025

🎊 PR Preview 6800f94 has been successfully built and deployed to https://quarkus-pr-main-49553-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

@Karm
Copy link
Member

Karm commented Aug 15, 2025

There will be conflicts after #49561 gets integrated, so it will need a rebase. Overall, I am not sure what "better accessibility means", could you elaborate @KohiiTM , please?

@Karm
Copy link
Member

Karm commented Aug 15, 2025

@KohiiTM I like the part where you push the builder image option first, but IMHO it needs an explanation right off the bat that one needs a native-image tool that comes e.g. with GraalVM or Mandrel and that the tool could be either in a builder image or downloaded and installed on your OS just like a JDK.

Left: Link | Rught: Link

review-docs

@KohiiTM
Copy link
Author

KohiiTM commented Aug 15, 2025

@Karm Thank you for the feedback. I appreciate you taking the time to review it. I agree with your suggestion to add an explanation about the need for a native-image tool right at the beginning.

Regarding your question about better accessibility, my goal was to make the documentation less intimidating for new users. I thought that by leading with a simpler, container-based approach, it would feel more approachable since it has fewer upfront prerequisites. My commit wording can definitely be changed to be more specific.

  - Lead with container-based builds requiring only Docker/Podman
  - Move intimidating prerequisites (C development environment) to later section
  - Keep initial prerequisites short and focused
  - Reorganize content to be more beginner-friendly while preserving all technical details

  Fixes quarkusio#49398
@KohiiTM KohiiTM force-pushed the docs/restructure-native-executable-guide branch from 54cee2e to c9132ac Compare August 15, 2025 19:29
@KohiiTM
Copy link
Author

KohiiTM commented Aug 15, 2025

Ignore; I have not made any changes yet.

This comment has been minimized.

  Add explanation of what the native-image tool is and how it can be obtained
  (locally via GraalVM/Mandrel or through container images) in the Prerequisites
  section to address feedback that users need conceptual understanding before
  jumping into implementation steps.

  Fixes quarkusio#49398
Copy link

quarkus-bot bot commented Aug 15, 2025

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 9fbad6f.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@KohiiTM KohiiTM marked this pull request as draft August 18, 2025 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants