Skip to content

feat!: Remove ExampleConfig from client,servers and protobuf#167

Merged
yevgenypats merged 2 commits intomainfrom
feat/remove_example_config
Sep 22, 2022
Merged

feat!: Remove ExampleConfig from client,servers and protobuf#167
yevgenypats merged 2 commits intomainfrom
feat/remove_example_config

Conversation

@yevgenypats
Copy link
Copy Markdown
Contributor

@yevgenypats yevgenypats commented Sep 22, 2022

Also: Improve documentation

Nit: Improve makefile there is no need to support automated requirements install for all platforms but rather just link to original docs for developers.

Summary

Use the following steps to ensure your PR is ready to be reviewed

  • Read the contribution guidelines 🧑‍🎓
  • Run go fmt to format your code 🖊
  • Lint your changes via golangci-lint run 🚨 (install golangci-lint here)
  • Update or add tests 🧪
  • Ensure the status checks below are successful ✅

@yevgenypats
feat!: Remove ExampleConfig from client,servers and protobuf
2c4b3dd 
Also: Improve documentation

Nit: Improve makefile there is no need to support automated
requirements install for all platforms but rather just link
to original docs for developers.
@hermanschaaf
Copy link
Copy Markdown
Contributor

hermanschaaf commented Sep 22, 2022

I liked @erezrokah's suggestion here; keeping plugin config that can work out of the box assuming the correct environment variables are set. We can still link to the docs for information about all the options, but it would be nice if you could run gen followed by sync and for it to then work without any config changes.

erezrokah
erezrokah requested changes Sep 22, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@erezrokah erezrokah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and removes a lot of information that belongs in our issue/PR templates.

Added a few comments

@yevgenypats @erezrokah
Update CONTRIBUTING.md
1e68d43 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats
Copy link
Copy Markdown
Contributor Author

yevgenypats commented Sep 22, 2022

I liked @erezrokah's suggestion here; keeping plugin config that can work out of the box assuming the correct environment variables are set. We can still link to the docs for information about all the options, but it would be nice if you could run gen followed by sync and for it to then work without any config changes.

gen and sync will still work out of the box given the defaults that we have in place (or should if not). Regarding cloudquery/cloudquery#1945 (comment) - I think it's a future easy improvment but right now pointing to the latest should be good enough while focusing on making sure we have the right documentation as of right now the latest documentation is not up to date with the code itself :)

erezrokah
erezrokah reviewed Sep 22, 2022
View reviewed changes
erezrokah
erezrokah approved these changes Sep 22, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@erezrokah erezrokah left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved to unblock. The www is minor but I don't think we should be using the old docs domain, if we moved that site under https://cloudquery.io/docs.

Unless I'm missing anything I don't see a reason to use the docs.cloudquery.io domain.

I'm not an SEO expert but there's more information in https://www.searchenginejournal.com/subdomains-vs-subfolders-seo/239795/

@yevgenypats yevgenypats merged commit 23b1575 into main Sep 22, 2022
@yevgenypats yevgenypats deleted the feat/remove_example_config branch September 22, 2022 14:02
@cq-bot cq-bot mentioned this pull request Sep 22, 2022
Merged
kodiakhq bot pushed a commit that referenced this pull request Sep 22, 2022
@cq-bot
chore(main): Release v0.8.0 (#168)
19ac0fc 
🤖 I have created a release *beep* *boop*
---


## [0.8.0](v0.7.13...v0.8.0) (2022-09-22)


### ⚠ BREAKING CHANGES

* Remove ExampleConfig from client,servers and protobuf (#167)

### Features

* Remove ExampleConfig from client,servers and protobuf ([#167](#167)) ([23b1575](23b1575))

---
This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erezrokah erezrokah erezrokah approved these changes

+1 more reviewer

@hermanschaaf hermanschaaf hermanschaaf approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@yevgenypats @hermanschaaf @erezrokah