Permissions
Org Admin | Team Manager (for assigned team) | Org Contributor | External Contributor |
View Configure | No access | No access | No access |
This article explains how to use devActivity's embeddable widgets to showcase your organization's activity on GitHub visually. These widgets can be embedded into your GitHub repository Readme file, GitHub Pages, or any other platform that supports markdown.
Overview
devActivity provides a variety of widgets that you can use to display dynamic data visualizations related to your organization's activity. These widgets are a great way to add visual interest to your GitHub repository and highlight key contributors, achievements, and project stats.
Core Features and Functionalities
Available Widgets
devActivity offers the following widgets:
Top Contributors Widget: Displays the top contributors over a chosen period (e.g., last 45 days). You can set the maximum number of contributors to display and toggle the display of contribution levels.
Active Challenges Widget: Showcases active challenges with their corresponding icons and titles. You can set the maximum number of challenges to display.
Achievements Widget: Highlights achievements with their respective icons and titles. You can set the maximum number of achievements to display.
Cycle Time Widget: Presents cycle time data, including total cycle time, coding time, pickup time, and review time, for the last 30 days.
Repo Stats Widget: Displays repository statistics for a selected period. You can customize the period to consider and choose the text color for the widget.
How to Embed a Widget
Select the widget: Go to the "Embeddables" tab and choose the widget you want to embed from the list of available widgets.
Preview/Copy Code: Click the "Preview/Copy Code" button on the widget.
Copy Markdown Code: A pop-up window will appear with the widget preview and markdown code. Click the "Copy" button to copy the code.
Paste into your platform: Paste the copied markdown code into your desired platform, such as your GitHub Readme file.
Best Practices and Use Cases
Here are some tips for effectively using devActivity's embeddable widgets:
GitHub Repository Readme: Embed widgets to showcase your project's activity and attract potential contributors.
GitHub Pages: Use widgets to create a dedicated page for your organization's activity, highlighting achievements and top performers.
Project Documentation: Include widgets in your project documentation to provide context and insights into the development process.
Common Issues and Troubleshooting
Incorrect Markdown Code: Ensure you have copied the correct markdown code for the widget.
Widget Not Displaying: Check your platform's markdown rendering capabilities. Some platforms may not support all markdown features.
Outdated Data: If the widget displays outdated data, refresh the page or click the "Sync now" button in the devActivity settings.
By leveraging devActivity's embeddable widgets, you can add a dynamic and engaging visual element to your GitHub projects, showcasing your organization's activity and attracting potential contributors.