Appvibe Mermaid Integration
Overview of Features
Key Features
Feature 1: Add Links: Embed Mermaid links directly into Jira issues for quick access to spreadsheets. This feature helps users quickly navigate to important data without leaving their Jira environment, enhancing productivity by streamlining the workflow.
Feature 2: Edit Links: Update or modify embedded Mermaid links as the spreadsheet changes. Users can easily keep their links current, ensuring that the Jira issue always points to the most relevant and updated spreadsheet content.
Feature 3: Remove Links: Remove links when they are no longer relevant. Users can maintain a clean and organized Jira environment by eliminating obsolete or irrelevant links, reducing clutter and confusion.
Feature 4: View Links in Preview and Full Screen: Preview Mermaid content or expand it to full screen. This feature provides flexibility in viewing links, allowing users to either quickly glance at the content or delve into more detailed analysis as needed.
Feature 5: Sort Links: Organize Mermaid links by custom criteria, name, or date. Users can efficiently manage and locate their links by sorting them according to specific preferences or project requirements, facilitating better issue tracking.
Feature 6: Realign Links: Adjust the positioning of Mermaid links within the Jira issue. This allows users to customize the visual layout of their Jira issues, enhancing both usability and aesthetic organization.
Feature 7: View Links in List or Tile View: Toggle between list or tile layout for viewing links. Users have the choice to switch between different visual representations of links, catering to personal preference or particular project demands.
Feature 8: Manage Permissions: Control who can view and interact with Mermaid links embedded in Jira. By setting permissions, users can ensure that sensitive information is only accessible to authorized team members, enhancing privacy and security.
Feature 9: View Link History: Access the history of changes made to each Mermaid link. This feature provides a record of modifications, helping users track the evolution of links and maintain a clear audit trail for project management purposes.
Getting Started
Installation
Step 1:
Log in to Jira
Ensure you are logged in with Admin privileges.
Step 2:
Open the Atlassian Marketplace
In Jira, click on Apps → Explore more apps to open the Marketplace.
Step 3:
Search for Appvibe Mermaid Integration
Use the search bar to find the app.
Step 4:
Install the App
Click Get app or Try it free.
Confirm the installation and grant the required permissions.
Step 5:
Configure the App
Once installed, go to Manage Apps in the Admin section to ensure it's enabled.
The panel will now appear in your Jira issue view.
Step 6:
Start Using the App to add and view links for Mermaid
Open any Jira issue to view, add, or manage Mermaid links directly.
Working with Links
Add a Link
Step 1:
Inside a Jira issue, click the "Add" button. A form will appear inline, allowing you to enter:
- Embedded URL: The link to your Mermaid design.
- Title: A meaningful name for the design (optional).
Step 2:
View a Link
Step 1:
Inside a Jira issue, locate the link you want to view.
Step 2:
Click the view icon for that link. An inline popup will appear showing your Mermaid.
Step 3:
Click the popup for full screen viewing.
Edit a Link
Step 1:
Inside a Jira issue, find the link you want to edit and click the "Edit" from the link dropdown. A form will appear inline, allowing you to edit the following:
- Embedded URL – The link to your Mermaid design.
- Title – A meaningful name for the design. (optional)
Step 2:
Click the save button again to add your Mermaid link to the Jira issue.
Delete a Link
Step 1:
Inside a Jira issue, navigate to the link you want to remove.
Step 2:
Advanced
View Link History
Step 1:
Install the Appvibe Mermaid Integration from the Jira marketplace to integrate Mermaid diagrams into your Jira issues seamlessly.
Step 2:
Utilize the app to create and modify Mermaid diagrams directly within your Jira issues. Every change you make to a Mermaid link is automatically tracked.
Step 3:
Access the modification history of any Mermaid link whenever needed. This history is stored at both the link level and Jira issue level, ensuring comprehensive accountability and transparency.
Step 4:
View past iterations and edits of your diagrams at any time. This feature is vital for project tracking and maintaining a clear record of diagram modifications.
Step 5:
Once you access the history, you can analyze and revert to any previous version if necessary, allowing for better version control and collaboration within your team.
Link Permissions
Step 1:
Step 2:
Assign the desired permissions for each user. Options include:
- Viewer: Users with view permission can see the link in the Jira issue.
- Editer: Users with edit permission can add, edit, or remove links in the Jira issue.
- Admin: Users with admin permission can manage link permissions for other users.
Help
FAQ
What if the Mermaid link doesn’t load?
Ensure the link is public and accessible. If Mermaid blocks embedding, try opening it in a new tab.
Can I add multiple links to one issue?
Yes, you can add multiple Mermaid links to each Jira issue.
How secure are my Mermaid links?
All links and related meta data are stored within Atlassian's Forge platform, which integrates into Atlassian's cloud infrastructure. This setup ensures that app data benefits from the same data residency features as Atlassian's core products, allowing administrators to control where the data is hosted.
Support
Support and Contact
Overview:
We are committed to assisting you. The Appvibe Mermaid Integration app simplifies managing and accessing Mermaid designs directly within Jira. Enjoy seamless integration, ensuring your team's productivity without the need to toggle between different tools.
Support Contact:
For additional assistance, please reach out to your Jira administrator or visit our Support Page at https://www.appvibe.com/support