Skip to content

fix: Remove description from docs#92

Merged
kodiakhq[bot] merged 3 commits intocloudquery:mainfrom
erezrokah:fix/remove_doc_description
Sep 13, 2022
Merged

fix: Remove description from docs#92
kodiakhq[bot] merged 3 commits intocloudquery:mainfrom
erezrokah:fix/remove_doc_description

Conversation

@erezrokah
Copy link
Copy Markdown
Member

Summary

We don't generate the descriptions anymore (I think), so we should not generate them with the docs.
Also switched to snapshot testing so the output files are separated from the code.

Another possible implementation is to add an option to enable/disable the description column


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 ✅

@erezrokah erezrokah force-pushed the fix/remove_doc_description branch from f411ada to 5fc1128 Compare September 12, 2022 14:45
@hermanschaaf
Copy link
Copy Markdown
Contributor

FWIW, some columns do still have descriptions, but agree, let's remove it from the docs for now since they're mostly empty.

@kodiakhq kodiakhq bot merged commit 7df58df into cloudquery:main Sep 13, 2022
kodiakhq bot pushed a commit that referenced this pull request Sep 13, 2022
🤖 I have created a release *beep* *boop*
---


## [0.5.0](v0.4.2...v0.5.0) (2022-09-13)


### ⚠ BREAKING CHANGES

* Enable var names lint rule and fix issues (#88)
* Disable default completion command (#96)

### Features

* Disable default completion command ([#96](#96)) ([67fca4b](67fca4b))


### Bug Fixes

* Enable var names lint rule and fix issues ([#88](#88)) ([4a752b5](4a752b5))
* Remove description from docs ([#92](#92)) ([7df58df](7df58df))
* Remove empty test and enable some lint rules ([#90](#90)) ([514fba4](514fba4))

---
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants