Skip to main content

Merging Radar Information Into a Main or Design Branch

Get Started with Radar​

With Multiplayer’s System Auto-Documentation functionality (Radar) you can automatically discover, track, and detect drift in your system architecture, dependencies and APIs by directly connecting to your infrastructure.

Follow these steps to set up Radar.

Understand the information detected by Radar here.

Merging Radar Information Into a Main or Design Branch​

You can merge all the component information detected by Radar into the branch and platform selected during the set up process.

Merging information about existing components​

  • In the left-side menu, open “Radar”
  • Click “View” for a specific component
  • Review the detected information in the “API” tab and the “Dependencies Graph” tab
  • Click “Apply Radar Changes”

Create Newly Detected Components​

During the Radar set up process, if you select the option to “Auto-merge” detected information, you will also have the option to “Auto-create” newly detected components.

When “Auto-create” is enabled Radar will automatically create new components that don’t currently exist in your Multiplayer project under that name or alias.

When “Auto-create” is disabled you can manually review newly detected components and create them one by one or in bulk following these steps:

  • In the left-side menu, open “Radar”
  • Click the link 🔗 icon in the top right corner of Radar
  • Identify the component type
    • If a detected component is an alias of an existing component, after selecting “🔗 alias” you will be prompted to type the name of the existing component.
  • (Optional) Rename the component. Note that component names are case sensitive.
  • Click “Confirm”

Editing Components​

After merging the information detected by Radar into your “main” or other design branches, you can rename, edit, delete, and add information to components are any time.

  • Open your project
  • Create a new design branch
  • In the left-side menu, open “Components”
  • Select the component you want to edit

More about editing components here.

Next Steps​

You did it! What’s next?