Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add API docs #2249

Closed
wants to merge 1 commit into from
Closed

docs: add API docs #2249

wants to merge 1 commit into from

Conversation

andrewrynhard
Copy link
Member

@andrewrynhard andrewrynhard commented Jun 30, 2020 •
edited

Pull Request

What? (description)

Why? (reasoning)

Acceptance

Please use the following checklist:

  • you linked an issue (if applicable)
  • you included tests (if applicable)
  • you ran conformance (make conformance)
  • you formatted your code (make fmt)
  • you linted your code (make lint)
  • you generated documentation (make docs)
  • you ran unit-tests (make unit-tests)

See make help for a description of the available targets.

This change is Reviewable

smira
smira reviewed Jun 30, 2020
View reviewed changes
Copy link
Member

@smira smira left a comment

Choose a reason for hiding this comment

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

we could have probably used link to godoc for our client package as yet another source of API documentation?

we should probably improve our docstrings as well in that package.

and one thing missing is the meta we have to distribute the calls across the nodes (as it's not in proto anywhere)

docs/website/content/v0.6.en.json Outdated Show resolved Hide resolved
@andrewrynhard andrewrynhard added this to the v0.6 milestone Jun 30, 2020
@andrewrynhard andrewrynhard linked an issue Jun 30, 2020 that may be closed by this pull request
Add API docs #2219
Closed
@andrewrynhard
Copy link
Member Author

/rebase

@andrewrynhard
Copy link
Member Author

/approve

smira
smira reviewed Jul 1, 2020
View reviewed changes
Dockerfile Outdated Show resolved Hide resolved
@andrewrynhard
docs: add API docs
5409cae 
This adds API documentation that is generated from the protobuf
definitions.

Signed-off-by: Andrew Rynhard <andrew@rynhard.io>
@andrewrynhard andrewrynhard marked this pull request as draft July 22, 2020 17:48
@smira smira modified the milestones: v0.6, v0.7 Jul 31, 2020
@smira smira mentioned this pull request Sep 16, 2020
Closed
@smira smira closed this Sep 16, 2020
@andrewrynhard andrewrynhard deleted the api-docs branch October 24, 2020 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smira smira smira approved these changes

Assignees
No one assigned
Labels
status/approved
Projects
None yet
Milestone
v0.7
Development

Successfully merging this pull request may close these issues.

Add API docs
4 participants
@andrewrynhard @smira @rsmitty @talos-bot