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

Dokumentation files in modules create separate pages, should be partials instead

      Debezium's Antora documentation has a lot of small files in "modules". These are used as includes in other pages.

      Antora will render a page for each files in the modules.
      Example: https://debezium.io/documentation/reference/1.1/modules/logging/c_logging-concepts

      Impact:

      • Using a google search a user might end up one of the modules pages and be "lost"
      • Google will see duplicate content

      Suggested solution: Move modules to "partials".
      If they would be "partials" (in a "partials" folder), Antora wouldn't create single pages for each. Partials can be used in includes like before.

      Read more about partials here: https://docs.antora.org/antora/2.2/asciidoc/include-partial/

            [DBZ-1944] Dokumentation files in modules create separate pages, should be partials instead

            Released

            Jiri Pechanec added a comment - Released

            All the latest PRs merged for 1.0, 1.1 and 1.2. Thanks a lot, alexander.schwartz@gmx.net, much appreciated!

            Gunnar Morling added a comment - All the latest PRs merged for 1.0, 1.1 and 1.2. Thanks a lot, alexander.schwartz@gmx.net , much appreciated!

            Pull requests for master, 1.1 and 1.0 arrived. Ready for PR review.

            Alexander Schwartz (Inactive) added a comment - Pull requests for master, 1.1 and 1.0 arrived. Ready for PR review.

            Some of the pages where linking to the files that have been moved to partials. I'll created a new PR with the same JIRA issue.

            gunnar.morling - can you please re-open this issue? Thanks!

            Alexander Schwartz (Inactive) added a comment - Some of the pages where linking to the files that have been moved to partials. I'll created a new PR with the same JIRA issue. gunnar.morling - can you please re-open this issue? Thanks!

            Merged Ben's PRs for 1.1 and 1.0. Resolving.

            Gunnar Morling added a comment - Merged Ben's PRs for 1.1 and 1.0. Resolving.

            Merged to master (1.2), still needing equivalent change for 1.1 and 1.0. Cherry-picking seems not feasible due to diverging histories of these files, but alexander.schwartz@gmx.net described the "algorithm" for doing these changes on the master PR (linked above), so it shouldn't be hard to apply them for the older branches. behardesty is going to look into this.

            Gunnar Morling added a comment - Merged to master (1.2), still needing equivalent change for 1.1 and 1.0. Cherry-picking seems not feasible due to diverging histories of these files, but alexander.schwartz@gmx.net described the "algorithm" for doing these changes on the master PR (linked above), so it shouldn't be hard to apply them for the older branches. behardesty is going to look into this.

            AFAIK, _attributes.adoc isn't used anywhere. I'm not sure why it exists - I guess it was used at some point.

            The MySQL connector assemblies are in the navigation, so it makes sense that they'd need their own pages. I'm not entirely sure why they were added that way; rather than make each assembly a separate page, they could instead be included in the connectors/mysql.adoc file. That would be more consistent with the way the other connectors are documented (i.e. one page per connector).

            Ben Hardesty added a comment - AFAIK, _attributes.adoc isn't used anywhere. I'm not sure why it exists - I guess it was used at some point. The MySQL connector assemblies are in the navigation, so it makes sense that they'd need their own pages. I'm not entirely sure why they were added that way; rather than make each assembly a separate page, they could instead be included in the connectors/mysql.adoc file. That would be more consistent with the way the other connectors are documented (i.e. one page per connector).

            Hi behardesty / gunnar.morling, I've created the pull request.

            TL;DR: ready for review, some thoughts and decisions below.

            I saw in the _attributes.adoc the partialsdir attribute and assumed using it in the new places would make it easier for downstream. The newer `partial$` "family" suffix would have been the modern syntax, but this works only if downstream uses Antora or a custom include processor. Please let me know if this should be changed, and I'll update the PR.

            I preserved the separation of modules and assemblies, although I didn't fully understand its concept (seems to be a hierarchy thing ).

            The assemblies of the CDC-MySQL-Connector are still in pages: as they're referenced in the navigation and in several places for cross references, they need to have their own pages. Files from that directory are referenced in 22 places, see IDE screenshot below.

            Test that I performed locally: A local Antora run for the master doesn't show errors or warnings. The pages previously for modules are now longer created. All links in the navigation still work in the browsers.

            Alexander Schwartz (Inactive) added a comment - Hi behardesty / gunnar.morling , I've created the pull request. TL;DR: ready for review, some thoughts and decisions below. I saw in the _attributes.adoc the partialsdir attribute and assumed using it in the new places would make it easier for downstream. The newer `partial$` "family" suffix would have been the modern syntax, but this works only if downstream uses Antora or a custom include processor. Please let me know if this should be changed, and I'll update the PR. I preserved the separation of modules and assemblies, although I didn't fully understand its concept (seems to be a hierarchy thing ). The assemblies of the CDC-MySQL-Connector are still in pages: as they're referenced in the navigation and in several places for cross references, they need to have their own pages. Files from that directory are referenced in 22 places, see IDE screenshot below. Test that I performed locally: A local Antora run for the master doesn't show errors or warnings. The pages previously for modules are now longer created. All links in the navigation still work in the browsers.

            PR preparation started...

            Alexander Schwartz (Inactive) added a comment - PR preparation started...

            Hey alexander.schwartz@gmx.net, so as per Ben's comment above, a PR for switching to partials would be very welcomed. Thanks a lot!

            Gunnar Morling added a comment - Hey alexander.schwartz@gmx.net , so as per Ben's comment above, a PR for switching to partials would be very welcomed. Thanks a lot!

              Unassigned Unassigned
              alexander.schwartz@gmx.net Alexander Schwartz (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: