Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-11569

Configure Antora markdown plug-in

    XMLWordPrintable

Details

    Description

      Make any changes which are necessary to improve the Antora plug-in to convert AsterixDB markdown pages to AsciiDoc. For example, can it handle all the required markup — tables, links, etc.? How does it handle image references? Are there any places where we will need to do text replacement, or can we work around that?

      We have a fairly free hand to make any changes that we need to the upstream Markdown, bearing in mind that the Markdown has to be compatible with both the AsterixDB processing pipeline and ours.

      Note that we only copy the markdown files from the AsterixDB mirror. We do not copy their image files or example files. We always use our own local image files and example files, even for material which has been transcluded from the AsterixDB mirror. This means that, if any of the documentation from the AsterixDB mirror contains a link to an image or an example file, we need to make sure we've stored an image or example file with the same name in the place where the converted AsterixDB documentation expects to find it.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            simon.dew Simon Dew
            simon.dew Simon Dew
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty