Uploaded image for project: 'Debezium'
  1. Debezium
  2. DBZ-1598

Update documentation version attributes and use Antora attributes where possible

    XMLWordPrintable

Details

    • Task
    • Resolution: Obsolete
    • Major
    • None
    • None
    • documentation
    • None

    Description

      There are multiple places across the documentation where the version being referenced is still 0.10.0.Beta4. This is because the imported _attributes.adoc file was not updated when the 1.0 version was published.

      Antora provides a series of built-in attributes we can leverage seen below:
      https://docs.antora.org/antora/2.1/page/page-and-site-attributes/#page-attributes

      I propose we make use of these built-in attributes where possible. In particular, the page-version seems highly of use where we could replace explicit calls to debezium-version where we manage a major.minor.patch.type version scheme by this attribute instead and which would turn those references into just major.minor.

      So in our tutorial for example, rather than it saying
      "This tutorial walks you through running Debezium 0.10.0.Beta4..."

      Instead it would read
      "This tutorial walks you through running Debezium 0.10..."

      Obviously we could keep explicit references to the full semantic version where applicable, but I don't believe all are necessary.

      Attachments

        Issue Links

          Activity

            People

              ccranfor@redhat.com Chris Cranford
              ccranfor@redhat.com Chris Cranford
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: