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

Unwrap tooltips in the downstream configuration reference docs

XMLWordPrintable

      Fixes https://issues.redhat.com/browse/QDOCS-978

      The downstream docs engine is unable to render `tooltip`-s, so we need to unwrap the tooltips in the configuration reference into regular text within the table

      Example for the `quarkus.datasource."datasource-name".jdbc.transactions` config property:

      Before this PR:
      ```
      tooltip:enabled[Integrate the JDBC Datasource with the JTA TransactionManager of Quarkus. This is the default.], tooltip:xa[Similarly to `enabled`, also enables integration with the JTA TransactionManager of Quarkus, but enabling XA transactions as well. Requires a JDBC driver implementing `javax.sql.XADataSource`], tooltip:disabled[Disables the Agroal integration with the Narayana TransactionManager. This is typically a bad idea, and is only useful in special cases\: make sure to not use this without having a deep understanding of the implications.]
      ```

      After this PR:
      ```
      enabled: Integrate the JDBC Datasource with the JTA TransactionManager of Quarkus. This is the default.

      xa: Similarly to `enabled`, also enables integration with the JTA TransactionManager of Quarkus, but enabling XA transactions as well. Requires a JDBC driver implementing `javax.sql.XADataSource`

      disabled: Disables the Agroal integration with the Narayana TransactionManager. This is typically a bad idea, and is only useful in special cases: make sure to not use this without having a deep understanding of the implications.
      ```

      @MichalMaler please check

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

                Created:
                Updated:
                Resolved: