chore(ci): Lint markdown files#119
Conversation
| @@ -0,0 +1,109 @@ | |||
| github | |||
There was a problem hiding this comment.
This is the same as https://github.com/cloudquery/cloudquery/tree/bac87adb620104eb4eb7fcc715cfe6c44c96f8f5/.github/styles.
As a follow up we could create a dedicated repository just for those files and publish the styles as a zip artifact, then use a URL instead of a directory
|
|
||
| The following is a set of guidelines for contributing to this repository. | ||
|
|
||
|
|
There was a problem hiding this comment.
GitHub automatically generates table of content for markdown files
|
|
||
| CloudQuery has a pluggable architecture and is using the go-plugin to load, run, and communicate between plugins via gRPC. T | ||
|
|
||
|  |
There was a problem hiding this comment.
This image link is broken
| * Downloading, verifying, and running plugins | ||
| * Running policy packs | ||
|
|
||
| #### CloudQuery Plugins and CLI [Mono Repo](https://github.com/cloudquery/cloudquery): |
There was a problem hiding this comment.
Duplicate reference to the mono repo
|
|
||
| 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). | ||
|
|
||
| CloudQuery has a pluggable architecture and is using the go-plugin to load, run, and communicate between plugins via gRPC. T |
|
|
||
| ## How Can I Contribute? | ||
|
|
||
| ### Reporting Bugs |
There was a problem hiding this comment.
This seems like a duplication of information that should be in our issue templates
|
|
||
| ### Your First Code Contribution | ||
|
|
||
| Unsure where to begin contributing to CloudQuery? You can start by looking through these `beginner` and `help-wanted` issues: |
There was a problem hiding this comment.
We haven't used beginner anywhere. Also I think searching for 1 label should be enough. good first issue is a default label all GitHub repositories have
| #### Local Development | ||
|
|
||
| CloudQuery has the ability to be run locally with a corresponding local postgres database. To get it up and running follow the following instructions: | ||
| * [Building and Running the plugin Locally](../docs/index.md) |
README.md
Outdated
| @@ -1,20 +1,18 @@ | |||
| CloudQuery Plugin SDK  | |||
| ======================= | |||
| # CloudQuery Plugin SDK  | |||
There was a problem hiding this comment.
Use the same header format (# instead of =======================)
|
|
||
| ## Supported plugins | ||
|
|
||
| https://www.cloudquery.io/plugins |
There was a problem hiding this comment.
GitHub knows how to render those as links, but better to be explicit
|
Ah noticed some of the README changes are included in https://github.com/cloudquery/plugin-sdk/pull/118/files, so this PR should be merged after |
d8d7d6c to
3b48a2f
Compare
Summary
Adds linting to markdown files and fixes our README and Contributing guide (which some redundant/stale information, dead links, etc)
Use the following steps to ensure your PR is ready to be reviewed
go fmtto format your code 🖊golangci-lint run🚨 (install golangci-lint here)