Skip to main content

Linking to reality

We want to help teams bridge the gap between design and reality. In IcePanel you can link your model objects to the real world - Currently supporting source control, but lots more coming soon!

Currently supported: GitHub, Azure Devops, Bitbucket Server. More coming soon!

Free plan limits linking of up to 10 objects to 1 repo link.

Paid plans get unlimited objects to be linked and multiple links to each object.

What does linking to reality do?​

In IcePanel you can link your model objects to reality, such as code repo's, branches, folders and files. When those links move, change name or get deleted, we will notify you that that object may need to be updated in your IcePanel landscape.

When a link is marked as expired or missing, your Accuracy Score will reduce as a reminder to update the link or remove that object from your model - Helping you keep your documentation up-to-date!

You can also use this as a visual way to navigate straight to your code, going from the abstract design to the code, helping onboarding new teammates find what they're looking for, or others in your team/organization understand your system at the code level.

Inaccuracy from missing reality link

Setting up code repo linking​

You can set up your repo integration from the Manage organization page.

Set up from Organization management page​

  1. Go to your organization management page by clicking Manage organization found on your landscapes homepage
  2. Go to the Code repo integration tab
  3. Select the integration you want with the buttons
  4. Complete your setup on your selected repo

Set-up Azure Devops

Set-up BitBucket Server

Set-up GitHub

Linking IcePanel objects​

Once IcePanel has access to your repo, you can link your model objects to your files and folders.

To link objects to your code:

  1. Click on an object to select on it
  2. Click the Reality tab on the right-hand panel
  3. Click the Link to reality button to create a new link
  4. Select the type and the Link you want to attach to this object
  5. Give it a custom name if you want, to help others know what this link shows
  6. Click Add link

Tip: You can link multiple files to help people know different elements that makes this object function, such as configuration, infrastructure or code.

Missing links - Reduced Accuracy Score​

Once IcePanel sees that a link is expired or missing, your Accuracy Score will reduce and you will be notified that you need to update that link. Each diagram that inaccurate object is in will have an inaccuracy added too, until you fix them!

To fix a link:

  1. Select an object to focus on it
  2. Click the Reality tab
  3. Click the edit pencil button next to the broken link
  4. Open the file dropdown and select the new file or delete, with the delete button.

You can edit your links at anytime, including the custom name.

To edit a link:

  1. Select an object to focus on it
  2. Click the Reality tab
  3. Click the edit pencil button next to the broken link
  4. Open the file dropdown and select the new file, change the custom name or delete the link with the delete button

Coming soon...​

We have loads of ideas for other areas we can link to reality, but we want to hear from you - What in reality would you like to link to? [Contact us] (https://icepanel.io/contact) to let us know your ideas!