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

fix: improve docs #77

Merged
merged 19 commits into from
Oct 27, 2020
Merged

fix: improve docs #77

merged 19 commits into from
Oct 27, 2020

Conversation

daniel-sanche
Copy link
Contributor

@daniel-sanche daniel-sanche commented Oct 19, 2020 •
edited
Loading

Problem:
The generated docs on googleapis.dev are miseading. They advertise two versions of the API, when we actually only publish v2. It also makes it seem like the autogenerated library is the newer version and the handwritten layer is deprecated

This PR:

  • removed the autogenerated layer from the generated documentation at googleapis.dev
  • removed the misleading v1 version from googleapis.dev
  • improved the code samples on the README to use the hand-written layer instead of autogenerated code
  • changed branding in the docs from Stackdriver Logging to Cloud Logging and Container Engine to Kubernetes Engine
  • got the Kokoro docs-presubmit check to turn green

This should greatly reduce customer confusion

Fixes ##76 🦕

@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 19, 2020
@daniel-sanche daniel-sanche marked this pull request as ready for review October 20, 2020 00:29
@daniel-sanche daniel-sanche requested a review from a team as a code owner October 20, 2020 00:29
@simonz130 simonz130 added type: docs Improvement to the documentation for an API. api: logging Issues related to the googleapis/python-logging API. lang: python Issues specific to Python. labels Oct 26, 2020
busunkim96
busunkim96 reviewed Oct 27, 2020
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@daniel-sanche daniel-sanche requested a review from a team as a code owner October 27, 2020 19:26
@daniel-sanche daniel-sanche merged commit bdd9c44 into googleapis:master Oct 27, 2020
gcf-merge-on-green bot pushed a commit that referenced this pull request Nov 19, 2020
@release-please
chore: release 2.0.0 (#82)
174f224 
🤖 I have created a release \*beep\* \*boop\* 
---
## [2.0.0](https://www.github.com/googleapis/python-logging/compare/v1.15.1...v2.0.0) (2020-11-19)


### ⚠ BREAKING CHANGES

* Use microgenerator for GAPIC layer. See [UPGRADING.md](https://github.com/googleapis/python-logging/blob/master/UPGRADING.md) for details. (#94)
* removes support for webapp2 and other Python2 specific code

### Features

* pass 'client_options' to super ctor ([#61](https://www.github.com/googleapis/python-logging/issues/61)) ([c4387b3](https://www.github.com/googleapis/python-logging/commit/c4387b307f8f3502fb53ae1f7e1144f6284280a4)), closes [#55](https://www.github.com/googleapis/python-logging/issues/55)
* use microgenerator ([#94](https://www.github.com/googleapis/python-logging/issues/94)) ([ff90fd2](https://www.github.com/googleapis/python-logging/commit/ff90fd2fb54c612fe6ab29708a2d5d984f60dea7))


### Bug Fixes

* add default filter settings to list_entries ([#73](https://www.github.com/googleapis/python-logging/issues/73)) ([0a1dd94](https://www.github.com/googleapis/python-logging/commit/0a1dd94811232634fdb849cb2c85bd44e870642f))
* failing CI tests ([#70](https://www.github.com/googleapis/python-logging/issues/70)) ([96adeed](https://www.github.com/googleapis/python-logging/commit/96adeedbda16a5c21651c356261442478aaa867a))


### Code Refactoring

* remove python2 ([#78](https://www.github.com/googleapis/python-logging/issues/78)) ([bf579e4](https://www.github.com/googleapis/python-logging/commit/bf579e4f871c92391a9f6f87eca931744158e31a))


### Documentation

* update docs ([#77](https://www.github.com/googleapis/python-logging/issues/77)) ([bdd9c44](https://www.github.com/googleapis/python-logging/commit/bdd9c440f29d1fcd6fb9545d8465c63efa6c0cea))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@busunkim96 busunkim96 busunkim96 approved these changes

Assignees

@daniel-sanche daniel-sanche

Labels
api: logging Issues related to the googleapis/python-logging API. cla: yes This human has signed the Contributor License Agreement. lang: python Issues specific to Python. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@daniel-sanche @busunkim96 @simonz130