Embed devActivity Widgets Using Markdown

devActivity.com allows you to seamlessly integrate crucial developer activity metrics directly into your existing documentation platforms, such as GitHub READMEs or Confluence pages. By embedding devActivity widgets using pre-generated Markdown code, you provide stakeholders with real-time (daily updated) insights without them needing to leave their primary workflows. This enhances transparency, accessibility, and communication of team performance, making key data like cycle time readily available.

This guide will walk you through the simple steps to copy and embed devActivity widget code using Markdown.

How to Embed devActivity Widgets

1. Navigate to Embeddables: From your devActivity dashboard, click on 'Settings' in the top navigation. Then, select 'Embeddables' from the left-hand menu.
2. Select Your Widget: Browse the available widgets and locate the one you wish to embed (e.g., 'Cycle time Last 30 days widget'). Click the 'Copy Code' action associated with that widget. This will open a modal dialog titled 'Cycle time Widget Code'.
3. Access Markdown Code: Within the 'Cycle time Widget Code' modal, you will see instructional text like "Copy and paste the code below into the README." Locate the text area specifically labeled 'Markdown' which contains the embeddable code for your widget.
4. Copy the Code: At the bottom of the modal, click the 'Copy' button. This action will copy the entire Markdown code snippet to your clipboard.
5. Paste into Your Platform: Open your chosen external platform (e.g., a GitHub README file, a Confluence page, or any Markdown-supported documentation). Paste the copied Markdown code directly into the desired location.
6. View Embedded Metrics: Once pasted and the page is rendered, the embedded widget will display the relevant devActivity metrics. These metrics will automatically update once per day, ensuring data freshness without manual intervention.

Frequently Asked Questions

How can I embed devActivity metrics into my project documentation?

You can embed devActivity metrics by copying the pre-generated Markdown code for any widget from the 'Settings > Embeddables' section and pasting it into your documentation platform, such as GitHub READMEs or Confluence pages.

What is the process for integrating devActivity widgets with GitHub or Confluence?

Navigate to 'Settings > Embeddables', select the desired widget, click 'Copy Code', then choose the 'Markdown' option. Copy the code and paste it directly into your GitHub README or Confluence page.

Will the data in embedded widgets automatically update?

Yes, the data displayed in embedded devActivity widgets automatically updates once per day, ensuring that your stakeholders always see fresh, relevant metrics.

How do I get the Markdown code for an embeddable devActivity widget?

Access the 'Settings' menu, then go to 'Embeddables'. For your chosen widget, click 'Copy Code', and the Markdown code will be available in a dedicated text area within the modal dialog.