Atlassian Confluence

AppMap integrates with Confluence, the popular corporate wiki developed by the Atlassian.

Confluence facilitates robust documentation and knowledge sharing. AppMap automatically generates interactive software diagrams from run-time data, ensuring an accurate and up-to-date understanding of code architecture and behavior. This integration leverages the strengths of both platforms enabling teams to better understand, document, and collaborate on their software projects.

Requirements

1. A project containing AppMap Data.
   • How to make AppMap Diagrams in your code editor
   • How to make AppMap Diagrams using a GitHub action in CI
2. The AppMap app for Confluence.

Add AppMap Diagrams to a Document or Blog Post

1. Enter Edit Mode: Click the pencil icon to switch to Edit Mode in Confluence.

2. Attach AppMap File: Drag and drop the AppMap file from your file system or Finder into the Confluence page.

3. Insert AppMap: Click the plus sign to get the insert menu. Type in and select ‘AppMap’. A placeholder that looks like this will be added to the page:

4. Choose AppMap: Click the pencil under the placeholder to open the AppMap options. Select the AppMap you want to display from the dropdown menu and it will render.

   If your AppMap does not render, make sure that you are working on a published document. AppMap Diagrams will not render until the document has been published at least once

5. Adjust Width (Optional) The width adjustment controls at the bottom of the AppMap window can be used to view more of the AppMap inline.

6. Save Changes: Click the ‘Update’ button to apply the changes to your Confluence page.

7. Fullscreen Mode (Optional): Click on the ‘full screen’ icon in the AppMap use Fullscreen mode.

   If at any point you would like some help, join us in Slack! You'll find the AppMap team there, along with other AppMap users.

---