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

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

    XMLWordPrintable

Details

    Description

      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/

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated:
              Resolved: