You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-15
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,8 @@ The following is a set of guidelines for contributing to this repository.
13
13
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
14
14
15
15
[What should I know before I get started?](#what-should-i-know-before-i-get-started)
16
-
*[Core](#cq-core-repo)
17
-
*[SDK](#cq-provider-sdk-repo)
18
-
*[Provider](#cq-provider-repos)
16
+
*[CLI and Plugins](#cq-core-repo)
17
+
*[SDK](#cloudquery-plugin-sdk-repo)
19
18
20
19
[How Can I Contribute?](#how-can-i-contribute)
21
20
*[Reporting Bugs](#reporting-bugs)
@@ -37,39 +36,41 @@ This project and everyone participating in it is governed by the [CloudQuery Cod
37
36
38
37
### CloudQuery Architecture
39
38
40
-
CloudQuery has a pluggable architecture and is using the go-plugin to load, run, and communicate between providers via gRPC. To develop a new provider for CloudQuery, you don’t need to understand the inner workings of go-plugin as those are abstracted away via the [provider-sdk](#cq-provider-sdk-repo).
39
+
CloudQuery has a pluggable architecture and is using grpc (go-grpc) to communicate between source plugins, cli and destination plugins. To develop a new plugin for CloudQuery, you don’t need to understand the inner workings of grpc as those are abstracted away via the [plugin-sdk](#cloudquery-plugin-sdk-repo).
40
+
41
+
CloudQuery has a pluggable architecture and is using the go-plugin to load, run, and communicate between plugins via gRPC. T
#### CloudQuery Plugins and CLI [Mono Repo](https://github.com/cloudquery/cloudquery):
60
61
- Executed only by CQ-Core via gRPC
61
62
- Interaction with remote data sources:
62
63
- Initialization of clients
63
64
- Authentication
64
65
- Fetching of configuration information
65
-
- More information about developing your own provider can be found [here](https://docs.cloudquery.io/docs/developers/developing-new-provider)
66
+
- More information about developing your own plugin can be found [here](https://docs.cloudquery.io/docs/developers/developing-new-provider)
66
67
67
68
68
69
## How Can I Contribute?
69
70
70
71
### Reporting Bugs
71
72
72
-
This section guides you through submitting a bug report for the AWS Provider for CloudQuery. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer::cloud:, and find related reports :mag_right:.
73
+
This section guides you through submitting a bug report for the AWS Plugin for CloudQuery. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer::cloud:, and find related reports :mag_right:.
73
74
74
75
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster.
75
76
@@ -101,7 +102,7 @@ Include details about your configuration and environment:
101
102
102
103
### Suggesting Enhancements
103
104
104
-
This section guides you through submitting an enhancement suggestion for CloudQuery, including completely new features, minor improvements to existing functionality and new providers. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
105
+
This section guides you through submitting an enhancement suggestion for CloudQuery, including completely new features, minor improvements to existing functionality and new plugins. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
105
106
106
107
Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed.
107
108
@@ -131,10 +132,10 @@ If you don't see any issues that you think you can help with reach out to the co
131
132
#### Local Development
132
133
133
134
CloudQuery has the ability to be run locally with a corresponding local postgres database. To get it up and running follow the following instructions:
134
-
*[Building and Running the Provider Locally](../docs/index.md)
135
+
*[Building and Running the plugin Locally](../docs/index.md)
135
136
*[Connecting to a database](https://docs.cloudquery.io/docs/getting-started#spawn-or-connect-to-a-database)
136
-
*[Debugging a Provider](https://docs.cloudquery.io/docs/developers/debugging)
137
-
*[Developing a New Provider](https://docs.cloudquery.io/docs/developers/developing-new-provider)
137
+
*[Debugging a plugin](https://docs.cloudquery.io/docs/developers/debugging)
138
+
*[Developing a new plugin](https://docs.cloudquery.io/docs/developers/developing-new-provider)
0 commit comments