Uploaded image for project: 'Quarkus'
  1. Quarkus
  2. QUARKUS-5422

FAQ (frequently asked questions) documentation for extensions

XMLWordPrintable

      Preview link: https://quarkus-pr-main-42520-preview.surge.sh/version/main/guides/extension-faq

      This combines the

      • A list of FAQs
      • List of common extension tasks (dev service, rewrite byte code, etc) with links to a “how to”, indexed by the ‘problem being solved’ rather than the ’solution technology’

      goals from https://github.com/quarkusio/quarkus/issues/37288.

      ## FAQ for the FAQ 



          1. ~Uh, Holly, it doesn't build cleanly~

      ~It's waiting for https://github.com/quarkusio/quarkus/pull/42446 to merge. If we think that PR will be a long time I'll remove the cross-references to un-block this PR, but they fit in quite nicely so it would be nice to not have to redo them.~ #42446 has not been merged yet, but references to #42446 have been removed, in the hopes of allowing forward progress.

          1. Is this complete?

      Goodness me, no! But has been open for ages, so I decided not to let perfect be the enemy of good. Once we have a FAQ, we can iterate.

          1. Is the Diataxis type right?

      I wondered about this too, and consulted with @ebullient. We decided that this document is a pointer to other how-tos, and it’s ok that it itself doesn’t fit exactly into one of the diataxis types.

          1. Is the JobRunr link the right one?

      I wasn’t sure whether to link to the JobRunr repo or the extensions page. Normally the extensions page would link to the repo, but for JobRunr it doesn’t. I’ve raised an issue to try and get that sorted out, so decided to go for the ‘long term best’ link.

              Unassigned Unassigned
              olubyans@redhat.com Alexey Loubyansky
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: