Documentation

Table of Contents:


    Publishing documentation on Confluence

    2018-06-16
    Applies to: 7.1 (current), Article available also for: 6.3

    Dataedo 6 has a Confluence-friendly HTML export that you can embed in Confluence page.

    Before you start

    To be able to publish Dataedo export on Confluence you need:

    1. Separate web server (like Apache or IIS) to host Dataedo export HTML pages
    2. Confluence with HTML macros enabled (details below)

    How it works

    Confluence enables embedding external HTML in its pages. The disadvantage of this approach is that it requires separate web server to host Dataedo export HTML.

    Diagram

    Step 1: Publish export on web server

    You will need to host your Dataedo documentation on a separate web server. This is explained in this article:

    Publishing documentation on a web server.

    Step 2: Configure Confluence

    To embed Dataedo documentation in Confluence, first we need to enable HTML macros.

    Open Configuration pane in Confluence (you'll need administrator access), and click Manage add-ons on the list.

    Type html in the add-on searchbar and set filter to system add-ons. Expand Confluence HTML macros.

    Confluence - manage add-ons

    Find and enable html-xhtml macro and enable it.

    Confluence - enable html macro

    Step 3: Create a documentation page in Confluence

    On a new page, click the plus icon and from the list choose Other macros.

    Confluence - insert macro on a page

    Type html in the searchbar and double click the macro.

    Confluence - select html macro

    In the new box visible on the page, paste the script below, substituting the path of your documentation for https://dataedo.com/samples/html/enterprise/.

    <script id="dataedo" src="https://dataedo.com/samples/html/enterprise/confluence.js"></script>
    

    Confluence - paste the script

    Click the Publish button and your documentation's ready.

    Confluence - documentation is online

    Update changes

    If your documentation needs to be updated just overwrite your previous documentation on the web server with the new one. No changes are required in Confluence.

    Found issue with this article? Comment below
    Comments (0)