Embeddable Widgets FAQ: Your Questions Answered
devActivity's Embeddable Widgets allow you to bring live developer analytics and team insights directly into your external documentation. Here are answers to some frequently asked questions about this powerful feature.
How can I display devActivity metrics outside of the platform?
You can display devActivity metrics outside the platform by navigating to 'Settings' > 'Embeddables', selecting your desired widget, and copying the generated markdown code. This code can then be pasted into external documentation like GitHub READMEs or Confluence.
What markdown code do I use to embed a widget?
devActivity provides the specific markdown code for each embeddable widget. You don't need to write it manually. Just click the 'Preview / Copy Code' button next to the widget you want to embed in the 'Embeddables' section.
Can I share team achievements dynamically?
Yes, the Achievements Widget is specifically designed for this. It displays a grid of hexagonal achievement badges that update dynamically, allowing you to showcase team accomplishments in real-time within your external documents.
What is our current cycle time, and how can I share it?
Your team's current cycle time metrics (including coding, pickup, and review times) are available via the 'CYCLE TIME (LAST 30 DAYS) WIDGET'. You can generate its markdown code from 'Embeddables' and share these live metrics in any markdown-supported document.
How do I integrate devActivity data into my GitHub README or Confluence?
To integrate devActivity data, go to 'Settings' > 'Embeddables', copy the markdown code for your chosen widget, and then paste it directly into your GitHub README file or a Confluence page. The widget will automatically render and display the live data.
What types of widgets are available for embedding?
devActivity offers several embeddable widgets, including Achievements, Cycle Time (Last 30 Days), and Repo Stats (Last 45 Days). You can also embed widgets for Top Contributors and Active Challenges.
Do the embedded widgets update automatically?
Yes, all devActivity embeddable widgets are dynamic. Once you've pasted the markdown code, the content of the widget will automatically update to reflect the latest data from devActivity, ensuring your documentation is always current.
Who can benefit from using devActivity Embeddable Widgets?
Developers, Team Leads, Project Managers, Technical Writers, and Community Managers can all benefit. It helps in fostering transparency, celebrating achievements, providing continuous insights, and enhancing documentation for various audiences.
