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

Install our own Kroki server so that we can generate diagrams from textual descriptions.

    XMLWordPrintable

Details

    • Epic
    • Resolution: Fixed
    • Major
    • None
    • None
    • diagrams, docs-site
    • None
    • Add Kroki support to Antora builds
    • To Do
    • 1

    Description

      We are looking to streamline the creation of diagrams for the documentation. At the moment there are two broad methods that the developers/writers use to create diagrams:

      1. Use a third-party diagramming tool to create the diagram, generate an image file and then add that to the documentation set.
      2. Use a tool that can generate diagrams from textual descriptions, convert the diagram to the required format, then include the conversion in the documentation set.

      As the textual rendering tools such as Mermaid, PlantUML and DITAA become increasingly popular, we are looking at leveraging their advantages in our own documentation:

      • Textual diagrams will allow us, in some instances, to generate diagrams from source.
      • Textual diagrams take care of the mundane stuff like arranging connecting lines in the best way.
      • Textual diagrams can be DIFFed for version control.
      • Much easier to manage as they can be written directly into the documents.

       

      OpenDevise recommend using Kroki to generate the diagrams during the Antora build process. This usually involves just setting up the Antora playbook to point at a friendly Kroki server and then run the build process.

      However, for security reasons we'd prefer to use our own server, so we will need to set up Kroki and make it available to anyone building the Antora documentation.

      Attachments

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

        Activity

          People

            ray.offiah Ray Offiah
            ray.offiah Ray Offiah
            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