It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Bring information from GitHub into Confluence

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.

github-links-for-confluence-01.png

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

github-links-for-confluence-02.png

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

github-links-for-confluence-03.png

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.

github-links-for-confluence-04.png

When you want to display the latest open issue you could directly link to the issues page. Similar to the pull requests link above.

github-links-for-confluence-05.png

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.

github-links-for-confluence-06.png

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!

2 comments

hi there, the two external links are broken:

cheers

Like Move Work Forward likes this

Thanks for the feedback @Norberto Soares 

If you are talking about the Docs - they are broken on purpose, so that the Macros does not convert them. We inserted the link twice - the first one to show the original link and the second one to show the Macro in action.

 

Thanks again for your feedback and if you see anything we can improve please do not hesitate to reach out.

Comment

Log in or Sign up to comment
TAGS
Community showcase
Published in Confluence Cloud

The New and Improved Confluence Mobile App!

  Hey Community! I’m Stephanie Zhang, a Product Manager along with @Wei Heng on the Confluence mobile app. Our team has been hard at work to deliver helpful enhancements to the Con...

234,871 views 4 12
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you