Appvibe GitHub Integration
Overview of Features
Key Features
Feature 1:
Add Links: Embed GitHub links directly into Jira issues for quick access to spreadsheets. This feature streamlines the process of linking relevant code or documentation from GitHub into your workflow on Jira.
Feature 2:
Edit Links: Update or modify embedded GitHub links as the spreadsheet changes. Keep your team informed and ensure that the latest data is always accessible by updating existing links when required.
Feature 3:
Remove Links: Delete links when they are no longer relevant or needed. This helps in maintaining a clutter-free and organized issue management interface in Jira.
Feature 4:
View Links in Preview and Full Screen: View embedded GitHub content in Jira through a quick preview or expand it to full screen for a detailed examination. This enables seamless navigation between platforms without losing context.
Feature 5:
Sort Links: Organize GitHub links by applying custom criteria, such as name or date. This aids in quickly locating the relevant links needed for various components of the project.
Feature 6:
Realign Links: Customize and adjust the positioning of GitHub links within the Jira issue. This feature ensures that the most relevant links are prominently displayed according to user preferences.
Feature 7:
View Links in List or Tile View: Switch between a list or tile layout when viewing links. This flexibility allows users to choose a viewing format that best suits their needs and enhances readability.
Feature 8:
Manage Permissions: Control who can view and interact with GitHub links embedded in Jira. With this feature, you can ensure that only authorized users have access to sensitive information.
Feature 9:
View Link History: Access a comprehensive history of changes made to each GitHub link. This helps in auditing and tracking modifications over time, providing transparency in link management.
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 GitHub 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 GitHub
- Open any Jira issue to view, add, or manage GitHub 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 GitHub 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 and click the view icon for that link.
Step 2:
An inline popup will appear showing your GitHub. You can also click this for full screen viewing.
Edit a Link
Step 1:
Inside a Jira issue, find the link you want to edit and click "Edit" from the link dropdown. A form will appear inline, allowing you to edit the Embedded URL, which is the link to your GitHub design, and optionally, the Title, which is a meaningful name for the design.
Step 2:
Click the save button again to add your GitHub link to the Jira issue.
Delete a Link
Step 1:
Inside a Jira issue, navigate to the GitHub link you want to remove.
Step 2:
Step 3:
You will be prompted to confirm if you want to delete this GitHub link.
Advanced
View Link History
Step 1:
Integrate the Appvibe GitHub Integration app with your Jira account. This will enable tracking of all modifications made to GitHub links within Jira issues.
Step 2:
Once integrated, any changes to a GitHub link within a Jira issue are automatically recorded. The historical data of these changes is stored and can be accessed at any time, either at the link level or Jira issue level.
Link Permissions
Step 1:
Go to the Appvibe GitHub Integration configuration page, or click permissions from within the link settings in a Jira issue.
Step 2:
Select the desired permissions for each user. Available permissions include:
- Viewer: Users with this permission can see the link in the Jira issue.
- Editor: Users with this permission can add, edit, or remove links in the Jira issue.
- Admin: Users with this permission can manage link permissions for other users.
Help
FAQ
What if the GitHub link doesn’t load?
Ensure the link is public and accessible. If GitHub blocks embedding, try opening it in a new tab.
Can I add multiple links to one issue?
Yes, you can add multiple GitHub links to each Jira issue.
How secure are my GitHub links?
All links and related metadata are stored within Atlassian's Forge platform. Our app data is stored using Forge's hosted storage solutions, which are integrated 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:
The Appvibe GitHub Integration app simplifies the process of managing GitHub designs directly within your Jira workspace. By enabling seamless integration, your team can maintain their workflow without disruptions from switching between different platforms.
Support Contact:
Should you require additional assistance, please reach out to your Jira administrator or visit our Support Page at https://www.appvibe.com/support