Skip to content

docs: stop publishing autogenerated gapic and protobuf docs#952

Merged
kolea2 merged 4 commits intogoogleapis:mainfrom
igorbernstein2:cleanup-docs
Jan 14, 2022
Merged

docs: stop publishing autogenerated gapic and protobuf docs#952
kolea2 merged 4 commits intogoogleapis:mainfrom
igorbernstein2:cleanup-docs

Conversation

@igorbernstein2
Copy link
Contributor

@igorbernstein2 igorbernstein2 commented Oct 15, 2021

The Bigtable data protocol is substantially different from it's api and cannot
be expressed using GAPIC generator alone. Instead a manually written layer
was created to sit on top of the raw gapic & protobuf apis. Thus our public
surface is the manual layer, while the autogenerated code is considered an
internal implementation detail. To avoid confusing users, we should stop
publishing docs for internal apis.

Fixes #951

@igorbernstein2 igorbernstein2 requested a review from a team October 15, 2021 17:10
@igorbernstein2 igorbernstein2 requested a review from a team as a code owner October 15, 2021 17:10
@product-auto-label product-auto-label bot added the api: bigtable Issues related to the googleapis/nodejs-bigtable API. label Oct 15, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 15, 2021
The Bigtable data protocol is substantially different from it's api and cannot
be expressed using GAPIC generator alone. Instead a manually written layer
was created to sit on top of the raw gapic & protobuf apis. Thus our public surface
is the manual layer, while the autogenerated code is considered an internal
implementation detail. To avoid confusing users, we should stop publishing
docs for internal apis.
Copy link
Contributor

@kolea2 kolea2 left a comment

Choose a reason for hiding this comment

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

lgtm with one question

excludePattern: '(^|\\/|\\\\)[._]',
include: [
'build/src',
'protos'
Copy link
Contributor

Choose a reason for hiding this comment

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

is proto deletion (and not exclusion) intentional?

Choose a reason for hiding this comment

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

Yep

@kolea2 kolea2 added the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 10, 2021
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 10, 2021
@kolea2 kolea2 added automerge Merge the pull request once unit tests and other checks pass. owlbot:run Add this label to trigger the Owlbot post processor. labels Nov 10, 2021
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 10, 2021
@gcf-merge-on-green
Copy link
Contributor

Merge-on-green attempted to merge your PR for 6 hours, but it was not mergeable because either one of your required status checks failed, one of your required reviews was not approved, or there is a do not merge label. Learn more about your required status checks here: https://help.github.com/en/github/administering-a-repository/enabling-required-status-checks. You can remove and reapply the label to re-run the bot.

@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Nov 11, 2021
@kolea2 kolea2 added the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 14, 2022
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 14, 2022
@kolea2 kolea2 added automerge Merge the pull request once unit tests and other checks pass. owlbot:run Add this label to trigger the Owlbot post processor. labels Jan 14, 2022
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 14, 2022
@gcf-merge-on-green
Copy link
Contributor

Merge-on-green attempted to merge your PR for 6 hours, but it was not mergeable because either one of your required status checks failed, one of your required reviews was not approved, or there is a do not merge label. Learn more about your required status checks here: https://help.github.com/en/github/administering-a-repository/enabling-required-status-checks. You can remove and reapply the label to re-run the bot.

@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Jan 14, 2022
@kolea2 kolea2 merged commit 0f28853 into googleapis:main Jan 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigtable Issues related to the googleapis/nodejs-bigtable API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs to explicitly steer users to use the correct public surface

3 participants