Skip to content

chore(docs): Add more godoc to important APIs#118

Merged
kodiakhq[bot] merged 11 commits intomainfrom
feat/more_docs
Sep 18, 2022
Merged

chore(docs): Add more godoc to important APIs#118
kodiakhq[bot] merged 11 commits intomainfrom
feat/more_docs

Conversation

@yevgenypats
Copy link
Copy Markdown
Contributor

@yevgenypats yevgenypats commented Sep 16, 2022 •
edited
Loading

As part of the v2 release we want to improve documentation for developers and for our plugin-sdk.

Right now we have a bit of mix-match of tutorials and docs https://www.cloudquery.io/docs/developers/sdk/provider/configuration

What we want to achieve:

There is still much more documentation to be added with some more examples but this should be a good start.

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 yevgenypats changed the title doc: Add more godoc to important APIs chore(docs): Add more godoc to important APIs Sep 16, 2022
erezrokah
erezrokah approved these changes Sep 18, 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.

Thanks @yevgenypats, I'm not sure all my comments makes sense so I would consider all non blocking.

I do think we should avoid docs that describe a standard operation of a get function (e.g. Name returns the name) and try to add more information when we can.

specs/doc.go
@@ -0,0 +1,3 @@
// Package specs specs for source and destination plugins including
Copy link
Copy Markdown
Member

@erezrokah erezrokah Sep 18, 2022

Choose a reason for hiding this comment

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

I'm not sure I understand what message this comment is trying to convey

yevgenypats and others added 5 commits September 18, 2022 15:54
@yevgenypats @erezrokah
Update codegen/doc.go
30f0353 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats @erezrokah
Update schema/doc.go
9a79683 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats @erezrokah
Update specs/source.go
31e9bc1 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats @erezrokah
Update specs/source.go
8aca4c3 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats @erezrokah
Update specs/source.go
12eacd3 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats
Copy link
Copy Markdown
Contributor Author

yevgenypats commented Sep 18, 2022

Thanks @yevgenypats, I'm not sure all my comments makes sense so I would consider all non blocking.

I do think we should avoid docs that describe a standard operation of a get function (e.g. Name returns the name) and try to add more information when we can.

Thanks @erezrokah ! Yeah it was my first try def room for improvement, all comments makes sense!

yevgenypats and others added 4 commits September 18, 2022 15:56
@yevgenypats @erezrokah
Update specs/source.go
515e2a3 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats @erezrokah
Update specs/source.go
1d0a9e4 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats @erezrokah
Update plugins/docs.go
873a584 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@yevgenypats @erezrokah
Update serve/doc.go
ac3a859 
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
@erezrokah
Copy link
Copy Markdown
Member

erezrokah commented Sep 18, 2022

Thanks @erezrokah ! Yeah it was my first try def room for improvement, all comments makes sense!

🚀 Looks good to me, maybe have a native English speaker cc @bbernays or @hermanschaaf look at this too

@kodiakhq kodiakhq bot merged commit 4163e8d into main Sep 18, 2022
@kodiakhq kodiakhq bot deleted the feat/more_docs branch September 18, 2022 15:04
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

@hermanschaaf hermanschaaf Awaiting requested review from hermanschaaf

Assignees

No one assigned

Labels

automerge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@yevgenypats @erezrokah