Documentation for Administrators
If you want to add a documentation page, which will be visible when browsing through libraries in a library repository, or when reviewing installed libraries in the Libraries section in the CloverDX Server UI, the documentation must be in a separate file placed in the root of the source project before exporting the library. We support three file names (case-insensitive, in the preferred order):
-
readme.md - rendered markdown - (a layout used in the CloverDX Marketplace libraries). You can use our Data Catalog Connectors template library, which includes a sample .md file for convenience.
-
readme.txt - plain text
-
readme - plain text