Navigation
This version of the documentation is archived and no longer supported.

Adding Images

Note

This guide is advisory, and its suggestions do not necessarily apply to every situation.

With Giza

Some MongoDB documentation projects use Giza’s image generation. This can be effective when you need images rendered at different sizes for different output formats.

It has the following disadvantages:

  • Giza only accepts SVGs: you must embed raster files inside of an SVG,
  • Giza invokes inkscape for each input file, and
  • Reliability problems. There was one instance where giza generated some images sans any text.

Giza looks for the path listed in system.files.data.files within config/build_conf.yaml for a manifest containing image metadata.

The image metadata is a YAML list of documents such as the following:

name: opsmanager-large
alt: "A highly available deployment uses horizontal scaling of the application database and backup    blockstore database, as well as multiple backup daemons."
output:
  - type: print
    tag: 'print'
    dpi: 300
    width: 2100
  - type: web
    dpi: 72
    width: 700

From this example, Giza will generate the following files in the build directory:

  • /source/images/opsmanager-large.rst
  • /source/images/opsmanager-large.png
  • /source/images/opsmanager-large-print.png