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

Missing links in filter and content-based SMT doc

    XMLWordPrintable

Details

    Description

      In the doc for the filter SMT and the content-based routing SMT, in the section, "Language specifics",  the second paragraph (filter SMT) or the second sentence (content-based SMT) starts with: 

      For example, as shown in , when you .....

      There should be a link to the basic configuration example just before the second comma. The link is missing because the source file has no target text enclosed in [ ] at the end of the link. 

      This is already fixed downstream. The work for this Jira is to fix this upstream and backport it to 1.2 to correctly render the upstream 1.2 doc. 

      The update already described is the only update that MUST be backported to 1.2 because it negatively affects the rendered/published 1.2 upstream doc. 

      As long as we are making this change, it would be good to also make the following format updates. Again, these updates are already in place downstream. There is no need to fetch this updated doc. These updates make the doc for these SMTs consistent with conventions used elsewhere in the doc. There is no requirement to backport these updates to 1.2 but there is also no harm and should be no conflicts in backporting to 1.2. 

      • Remove the extra "=" signs from table formats. A table should begin with "|===" and end with "|===".  
      • Add column widths and headers to tables. For example, for the content-based SMT, the table for expression variables now has this declaration downstream:
        [cols="25%a,35%a,40%a",subs="+attributes",options="header"]

      To get the column widths correct for downstream rendering, copy the column declaration from the downstream files. 

      • In the content-based SMT doc, add a downstream-only "Procedure" heading to the setup section. 
      • Replace "e.g." in the description of the language config option for both SMTs. 
      • Insert {zwsp} in table entries to ensure user-friendly line breaks downstream. Use the already updated downstream files to determine where they are needed. It turns out that there is no harm in inserting them where they are not needed. In other words, extra {zwsp} instances do not cause a problem. 

       

      Attachments

        Activity

          People

            broldan@redhat.com Robert Roldan
            tcohen@redhat.com Tova Cohen (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: