Details
-
Feature
-
Resolution: Done
-
Critical
-
None
-
None
-
Quarkus Docs Sprint 5, Quarkus Docs Sprint 6, Quarkus Docs Sprint 7, Quarkus Docs Sprint 8, Quarkus Docs Sprint 9, Quarkus Docs Sprint 10, Quarkus Docs Sprint 11, Quarkus Docs Sprint 12, Quarkus Docs Sprint 13
-
13
Description
Latest Elektra content preview on pre-production portal PVII:
Getting Started Guide:
Developing and compiling your Quarkus applications with Apache Maven
SME: Erin Schnabel @ebullient@redhat.com, rhn-sa-tqvarnst
Community guide: https://quarkus.io/guides/cli-tooling
Updates from the Content planning call with Thomas:
The Quarkus CLI tool is supported for development only, not for production.
Likewise, the CLI tool is not tested, or shipped, by Red Hat and is an upstream tool.
Due to this, we do not have an official way of installing the CLI tool that we could point the customers to.
How we handle this is product docs?
We do not document an installation method directly in the product documentation.
Instead we point to the community guide for installation instructions.
As mentioned before, none of the methods are official and CLI is not supported in production, so users can pick any of the installation method to get the tool onto their system.
We should make it clear that Quarkus CLI is not supported in production (we will do this in the release notes)
In product guides that describe actions based on the Quarkus Maven Plugin, we should add equivalent steps on the Quarkus CLI.
Effectively, this will give the user an alternative approach to performing the steps described I the guide.
We should mention having the CLI installed as a prerequisite to guides that reference its usage, but we need to make sure make it clear that using the CLI is optional.
for example, we could say something like: OPTIONAL: You have the Quarkus CLI installed (Quarkus CLI is intended for development only. Red Hat does not provide support for using the Quarkus CLI in production environments)
