Back
All posts

Bring information from GitHub into Confluence

March 6, 2024
<a href="https://www.freepik.com/free-vector/business-team-brainstorm-idea-lightbulb-from-jigsaw-working-team-collaboration-enterprise-cooperation-colleagues-mutual-assistance-concept-pinkish-coral-bluevector-isolated-illustration_11667116.htm#query=collaboration&position=2&from_view=keyword&track=sph&uuid=21ea3c1d-7461-49c7-9157-5822c4372896">Image by vectorjuice</a> on Freepik

I’ve got a couple of questions for you.

Do you write technical documentation? What about technical documentation that references code and files from GitHub?

In this article you will learn how to increase value of Confluence and GitHub working together.

Technical Specification

There is a good practice to lightly document your technical steps before jumping directly into the code. This practice helps you to structure thoughts and enables you to get some feedback on your implementation steps. One of the easiest ways to reference to the previous work is to link to the previously merged pull requests or concrete files.

In your tech spec you can add a link to a readme file from the repository you can use as an example. It may look something like this.

Confluence GitHub integration for readme files

Then the person who reviews your technical specification can expand and review it without leaving Confluence and loosing the context.

Confluence GitHub integration for open readme files

Also you may want to reference a pull request on which your task depends or learns from.

Confluence GitHub integration for pull requests and user profiles

Display GitHub open issues or pull requests

Another way to quickly grasp the amount of open pull request in GitHub is to use a link to the pull requests https://gthub.com/atlassian/quickstart-atlassian-jira/pulls in your product.

Confluence GitHub integration for GitHub issues

When you want to display the the latest open issues you could paste the link to the issues page from GitHub.

Confluence GitHub integration shows a list of issues in Confluence

Release pages and milestones

Multiple organization create a future or the next release page where they prepare the main themes of the release as well as teams and participants of it. If you organization uses GitHub milestones GitHub links for Confluence will be helpful here as well. Just copy the link to the milestone from GitHub, for instance, https://github.ca/microsoft/vscode/milestone/126 , and insert it in Confluence using GitHub for Confluence macros.

Confluence GitHub integration for GitHub milestones

If the milestone is not your thing, you could use list of open pull requests.

You can give GitHub links for Confluence a try TODAY.

If there is something missing please reach out.

Welcome to our world and let’s Move Work Forward together!

Articles you might like

How to simplify project portfolio management using Jira
June 20, 2024
How to simplify project portfolio management using Jira
Jira is an incredibly powerful tool, however it may appear complex if not set up correctly. That’s why we’ve taken the time to help you set up what is called Project Central.
Read more >

Articles you might like

New blog posts

Best Practices for Managing Large GitHub Repositories in Confluence
October 3, 2024
Best Practices for Managing Large GitHub Repositories in Confluence
Managing large GitHub repositories in Confluence requires effective organization and resource utilization for maintaining a streamlined and efficient collaboration environment.
Read more >
Overcoming Common Agile Challenges: Solutions for Remote and Hybrid Teams
August 30, 2024
Overcoming Common Agile Challenges: Solutions for Remote and Hybrid Teams
Overcoming Common Agile Challenges: Solutions for Remote and Hybrid Teams
Read more >
Automating Confluence Updates in Microsoft Teams: A Comprehensive Guide
August 30, 2024
Automating Confluence Updates in Microsoft Teams: A Comprehensive Guide
Automating Confluence Updates in Microsoft Teams: A Comprehensive Guide
Read more >
Get productivity tips delivered straight to your inbox
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Atlassian Logo
Platinum Marketplace Partner
AICPA Logo
SOC 2 Type II Certified
Gitlab Logo
GitLab Official partner
EU GDPR Logo
EU GDPR Compliant
Google Logo
Google Partner
Microsoft Logo
Microsoft Partner