Skip to content

Commit 1d841d7

Browse files
authored
Merge pull request #6 from squaredup/work/dc/pp
2 parents 74f8c3e + 7e9256d commit 1d841d7

4 files changed

Lines changed: 147 additions & 6 deletions

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!--
2+
Thanks for contributing a new community-authored SquaredUp plugin!
3+
-->
4+
5+
## 🔌 Plugin overview
6+
7+
- **Plugin name**:
8+
- **Purpose / problem solved**:
9+
- **Primary audience** (e.g. platform teams, SREs, product teams):
10+
11+
---
12+
13+
## 🧩 Plugin configuration
14+
15+
- **Authentication method(s)** (e.g. OAuth, Username/Password, API Key):
16+
17+
---
18+
19+
## 🖼️ Plugin screenshots
20+
<!--
21+
Please include screenshots of your plugin's UI & dashboards
22+
-->
23+
### Plugin configuration
24+
### Default dashboards
25+
26+
---
27+
28+
## 🧪 Testing
29+
30+
<!--
31+
Please describe the testing you have carried out for this new plugin
32+
-->
33+
34+
---
35+
36+
37+
## ⚠️ Known limitations
38+
39+
Are there any known gaps, constraints, or follow-up ideas?
40+
41+
---
42+
43+
## 📚 Checklist
44+
45+
- [ ] Plugin, datastream and UI naming follow SquaredUp guidelines
46+
- [ ] Logo added
47+
- [ ] One or more dashboards added
48+
- [ ] README added including configuration guidance
49+
- [ ] No secrets or credentials included
50+
- [ ] I agree to the [Code of Conduct](CODE_OF_CONDUCT.md)
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## 📋 Summary
2+
<!--
3+
Briefly describe what this PR does and why it's needed.
4+
5+
> Examples:
6+
> Adds a new `CPU Usage` datastream to expose CPU information for hosts
7+
> Fixes an issue when authenticating with OAuth
8+
-->
9+
10+
---
11+
12+
## 🔗 Related issue(s)
13+
<!--
14+
Link any related issues or discussions.
15+
16+
- Closes #
17+
- Relates to #
18+
-->
19+
20+
---
21+
22+
## 🧩 Plugin details
23+
24+
- **Plugin name**:
25+
- **Type of change**:
26+
- [ ] Bug fix
27+
- [ ] New datastream
28+
- [ ] Enhancement to existing datastream
29+
- [ ] Performance improvement
30+
- [ ] Documentation / metadata / logo
31+
- [ ] Other (please describe):
32+
33+
---
34+
35+
## ⚠️ Breaking changes
36+
37+
Does this PR introduce any breaking changes?
38+
39+
- [ ] No
40+
- [ ] Yes (please describe):
41+
42+
If yes, describe:
43+
- What breaks
44+
- Who is impacted
45+
- Any migration steps
46+
47+
---
48+
49+
## 📚 Documentation
50+
51+
- [ ] Documentation updated
52+
- [ ] No documentation changes needed
53+
54+
---
55+
56+
## ✅ Checklist
57+
58+
- [ ] No secrets or credentials included
59+
- [ ] Plugin, datastream and UI naming follow SquaredUp guidelines
60+
- [ ] I agree to the [Code of Conduct](CODE_OF_CONDUCT.md)
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--
2+
Use this PR template only for changes that do *not* introduce or a change a plugin.
3+
-->
4+
5+
## 📋 Summary
6+
<!--
7+
Describe what this PR changes.
8+
-->
9+
10+
---
11+
12+
## 🔍 Scope of change
13+
14+
- [ ] Documentation only
15+
- [ ] Repository metadata or configuration
16+
- [ ] CI / automation
17+
- [ ] Other (please describe):
18+
19+
---
20+
21+
## 📚 Checklist
22+
23+
- [ ] I agree to the [Code of Conduct](CODE_OF_CONDUCT.md)

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SquaredUp Community Plugins
22
[![Discourse Users](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.squaredup.com&style=flat-square&label=community&color=%23FFC72C)](https://community.squaredup.com)
3-
![Plugins](https://img.shields.io/github/directory-file-count/squaredup/plugins/plugins?type=dir&label=plugins&style=flat-square)
3+
[![Plugins](https://img.shields.io/github/directory-file-count/squaredup/plugins/plugins?type=dir&label=plugins&style=flat-square)](https://squaredup.com/plugins)
44
[![GitHub issues](https://img.shields.io/github/issues/squaredup/plugins?style=flat-square)](https://github.com/squaredup/plugins/issues)
55
[![License](https://img.shields.io/github/license/squaredup/plugins?style=flat-square)](https://github.com/squaredup/plugins/blob/main/LICENSE)
66

@@ -13,9 +13,10 @@ SquaredUp is the operational intelligence platform that enables data-driven IT a
1313
SquaredUp has 60+ plugins out of the box. This repository contains all community-authored plugins and provides guidance on how to author your own plugin and submit it this repository.
1414

1515
### Reporting issues or feature requests
16-
If you encounter a problem or have an idea on how to improve a _community-authored plugin_ you can raise an issue in this repository.
1716

18-
For issues/feature requests with _plugins authored by SquaredUp_ please use [Community Answers](https://community.squaredup.com) or contact our support team at support@squaredup.com
17+
- **Community-authored plugins**: Raise issues or improvement ideas directly in this repo - [create a new issue](issues/new/choose)
18+
- **SquaredUp-authored plugins**: Use [Community Answers](https://community.squaredup.com) or contact support@squaredup.com
19+
- **The SquaredUp platform itself**: Use [Community Answers](https://community.squaredup.com) or contact support@squaredup.com
1920

2021
## What is a plugin?
2122
Plugins are key components of SquaredUp. Each plugin defines how connect to and read data from a third-party system. A plugin typically includes:
@@ -25,11 +26,18 @@ Plugins are key components of SquaredUp. Each plugin defines how connect to and
2526
* **Out of the box dashboards** - useful dashboards to help users get started
2627
* **Index definition** - defines how SquaredUp indexes objects from a third-party system
2728

28-
## How do I use a plugin?
29+
> [!TIP]
30+
> We use the term `plugins` in code, while the UI refers to them as `data sources`.
31+
32+
[Learn more about plugins](https://docs.squaredup.com/features/connect-and-explore/plugins-and-data-sources)
33+
34+
## How do I use a data source?
2935
- Sign up for an account at app.squaredup.com
3036
- Browse to Data Sources -> +
31-
- Select your desired plugin from our catalog
32-
- Configure and add the plugin to get started
37+
- Select your desired data source from our catalog
38+
- Configure and add the data source to get started
39+
40+
[Learn more about adding a data source](https://docs.squaredup.com/first-steps/adding-a-data-source)
3341

3442
## How do I build my own plugin?
3543
> [!NOTE]

0 commit comments

Comments
 (0)