Skip to content

sync-cloud-supernova.md

Latest commit

 

History

History
205 lines (110 loc) · 8.17 KB

sync-cloud-supernova.md

File metadata and controls

205 lines (110 loc) · 8.17 KB
icon atom
cover ../../.gitbook/assets/SUPERNOVA-page-header-sync-provider.png
coverY 0

Supernova - Cloud Sync Provider

Supernova sync setup guide

Supernova is a design data platform popular for documenting design systems.

With the Tokens Studio plugin's integration with Supernova, you can create and manage Design Tokens and themes in Figma and sync to Supernova to create documentation.

{% hint style="info" %} The Supernova integration has some limitations and does not provide the same bi-directional sync or version control our Git provider integrations offer.

You may want to consider including a Git provider in your process in addition to Supernova. {% endhint %}

How it works

  • Gather Design System Data and Authentication token in Supernova.
  • Configure Supernova as a sync provider within the Tokens Studio plugin.
  • Use the plugin to sync your Design Tokens between Figma and Supernova to keep your Design Token documentation up to date.

Supernova setup steps

If you haven't already, sign up for a Supernova account at https://supernova.io/

1. Gather design system project information

Log into your Supernova account and navigate to the Design System Project that you'd like to sync with Tokens Studio.

  • You'll land on the Design Tokens page in Supernova for your project.
  • Save the URL of the Design Tokens page somewhere safe as it's needed for the plugin configuration.

{% hint style="info" %} Be sure to include the https:// in your URL copy {% endhint %}

Each Design System project will require different code snippets for mapping Tokens Studio to Supernova. It's best to consult the Supernova docs to gather the right mapping code snippets or reach out to them for support:

→ Basic mapping documentation on the Supernova site

→ Advanced mapping for working with themes and multiple brands on the Supernova site

2. Generate an access token

Not to be confused with anything to do with Design Tokens, an access token acts as a passcode from Supernova you enter into the plugin that allows the connection to happen.

Log into your Supernova account:

  • Navigate to the Authentication section of your project
  • Generate a new authentication token with the necessary permissions.
  • Save the generated access token somewhere safe as it's needed for the plugin configuration.

You're ready to configure the Tokens Studio plugin in Figma!

Configuring Tokens Studio Plugin

In Figma, open up the Tokens Studio plugin and navigate to the Settings page using the navigation tab.

  • Under the Sync providers section, select the Add new button to see a list of all Token storage providers
  • Select Supernova

Add credentials for Supernova

You'll need the information saved from the steps above to complete the JSONBin sync configuration form.

1. Name

  • This is a nickname that shows up in the plugin settings page later on to identify this specific sync provider configuration.
  • Choose something memorable to you and your project.
  • Example: radix ui components

2. Supernova access token

The Access token you saved from step 2 above.

3. Design System URL

The URL of your design system project from step 1 above

  • Example:https://supernova.io/ws/test/ds/amazingdesigner/radixtokens

4. Supernova < > Tokens Studio Mapping

The exact code snippets provided by Supernova (see the steps above) limit the data that Tokens Studio can sync to Supernova.

{% hint style="info" %} The mapping structure is important!

Its essential to have the correct mapping structure, so copy/paste the configuration as outlined in the Supernova docs precisely, including the square brackets [ ]. {% endhint %}

Example mapping configuration:

[
    {
        "tokenSets": ["global", "light"],
        "supernovaBrand": "Default"
    }
]

If you want to map multiple themes at once, then you can check out the Supernova docs on connecting to the plugin here.

Save and do the initial sync

Save to confirm your credentials, and then follow the plugin's prompts to finish setting up the Supernova sync.

{% include "../../.gitbook/includes/add-new-sync-provider.md" %}

Shared source of truth

As you work in the plugin, push and pull indicators remind you to stay in sync with Supernova.

{% include "../../.gitbook/includes/push-pull.md" %}

{% include "../../.gitbook/includes/transforming-tokens.md" %}

Limitations from Supernova

According to the Supernova docs, Design Tokens synced to Tokens Studio cannot be edited directly in Supernova; all edits must be made in the Tokens Studio plugin interface.

→ Read the Supernova docs here.

This means pulling tokens from Supernova will only show changes to tokens made in the Tokens Studio plugin that were pushed to Supernova.

Customer support

The Supernova team provides customer support for issues with Supernova sync, so you'll need to contact them directly through their support channels to triage issues and ask questions.

  • In the Tokens Studio community slack, we have a #supernove-sync channel moderated by the Supernova team.
  • This is a great place to post questions and concerns to help other community members who might be having the same experience. It also allows the Tokens Studio team to help out where we can!

Resources

Mentioned in this doc:

Community resources:

  • None yet!

{% include "../../.gitbook/includes/something-to-share-subm....md" %}

Known issues and bugs

Tokens Studio Plugin GitHub - Open issues for Sync Supernova

{% include "../../.gitbook/includes/bug-report.md" %}

Requests, roadmap and changelog

{% include "../../.gitbook/includes/featurebase.md" %}