Skip to content

Document private protocol methods for devsite #3440

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
Merged
merged 12 commits into from
Oct 23, 2020
Merged

Document private protocol methods for devsite #3440

merged 12 commits into from
Oct 23, 2020

Conversation

balopat
Copy link
Contributor

@balopat balopat commented Oct 23, 2020 •
edited
Loading

Fixes #2953.

Also adds a preview Dockerfile that is a seed for a potential preview service that could run as a GithubAction, deploy an ephemeral Cloud Run container to preview the generated docs and comment on the PR with the link. An example link for this particular change is: https://api-docs-fijpqdu4wa-uc.a.run.app/

While the preview is not "the real thing" - a fullblown devsite preview is not realistic at this point. This preview gives an indication about the intermediate markdown representation generated by tf-docs markdown generator. It's good for:

@google-cla google-cla bot added the cla: yes Makes googlebot stop complaining. label Oct 23, 2020
95-martin-orion
95-martin-orion approved these changes Oct 23, 2020
View reviewed changes
Copy link
Collaborator

@95-martin-orion 95-martin-orion left a comment

Choose a reason for hiding this comment

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

All looks good to me. As a potential follow-up item: on the api-docs preview, would it be feasible to show diffs for the source PR?

viathor
viathor approved these changes Oct 23, 2020
View reviewed changes
@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Oct 23, 2020
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Oct 23, 2020
@CirqBot CirqBot merged commit 5253f54 into quantumlib:master Oct 23, 2020
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@viathor viathor viathor approved these changes

@95-martin-orion 95-martin-orion 95-martin-orion approved these changes

@mpharrigan mpharrigan Awaiting requested review from mpharrigan

Assignees
No one assigned
Labels
area/docs cla: yes Makes googlebot stop complaining.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Protocol documentation are missing methods
6 participants
@balopat @mpharrigan @viathor @95-martin-orion @mhucka @CirqBot