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: update usage guide for v3.0.0 #456

Merged
merged 28 commits into from
Jan 26, 2022
Merged

docs: update usage guide for v3.0.0 #456

merged 28 commits into from
Jan 26, 2022

Conversation

daniel-sanche
Copy link
Contributor

@daniel-sanche daniel-sanche commented Dec 10, 2021 •
edited
Loading

This PR contains two major docs changes in prep for v3.0.0:

  • a major re-write of the usage guide, documenting everything I learned while working with the library over the last year
  • an UPGRADING.md update to describe major/breaking changes

The upgrading guide can be rendered here on GitHub. To render the usage guide locally, run the following commands:

cd python-logging
nox -s docs
cd docs/_build_html
python3 -m http.server 8085

@product-auto-label product-auto-label bot added the api: logging Issues related to the googleapis/python-logging API. label Dec 10, 2021
@snippet-bot
Copy link

snippet-bot bot commented Dec 10, 2021 •
edited
Loading

Here is the summary of possible violations 😱

There are 38 possible violations for not having product prefix.

The end of the violation section. All the stuff below is FYI purposes only.

Here is the summary of changes.

You are about to add 47 region tags.
You are about to delete 30 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@daniel-sanche daniel-sanche force-pushed the v3_usage_guide branch 6 times, most recently from 8c7f10e to 3184972 Compare December 15, 2021 00:28
@daniel-sanche daniel-sanche changed the title [WIP] docs: update usage guide for v3.0.0 docs: update usage guide for v3.0.0 Dec 15, 2021
@daniel-sanche daniel-sanche marked this pull request as ready for review December 15, 2021 01:11
@daniel-sanche daniel-sanche requested review from a team as code owners December 15, 2021 01:11
@daniel-sanche daniel-sanche requested review from busunkim96 and removed request for a team December 15, 2021 01:11
losalex
losalex approved these changes Dec 16, 2021
View reviewed changes
Copy link
Contributor

@losalex losalex left a comment

Choose a reason for hiding this comment

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

As we spoke earlier, this should be reviewed by writers as well

@product-auto-label product-auto-label bot added the stale: old Pull request is old and needs attention. label Jan 10, 2022
@arbrown
Copy link
Contributor

arbrown commented Jan 11, 2022

cd docs/_build_html

This directory was cd docs/_build/html on my machine. Not sure if it was a nox config issue or a typo.

arbrown
arbrown approved these changes Jan 11, 2022
View reviewed changes
Copy link
Contributor

@arbrown arbrown left a comment

Choose a reason for hiding this comment

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

Minor nits on pre-existing docs, otherwise looks good!

docs/direct-lib-usage.rst Outdated Show resolved Hide resolved
docs/direct-lib-usage.rst Outdated Show resolved Hide resolved
docs/direct-lib-usage.rst Outdated Show resolved Hide resolved
@product-auto-label product-auto-label bot added the size: xl Pull request size is extra large. label Jan 14, 2022
@daniel-sanche daniel-sanche merged commit 151a378 into v3.0.0 Jan 26, 2022
@daniel-sanche daniel-sanche deleted the v3_usage_guide branch January 26, 2022 22:16
@daniel-sanche daniel-sanche mentioned this pull request Jan 26, 2022
Merged
daniel-sanche added a commit that referenced this pull request Jan 27, 2022
@daniel-sanche
docs: update usage guide for v3.0.0 (#456)
8266de1
daniel-sanche added a commit that referenced this pull request Jan 27, 2022
@daniel-sanche
docs: update usage guide for v3.0.0 (#456)
8a67b73
@release-please release-please bot mentioned this pull request Jan 27, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@losalex losalex losalex approved these changes

@arbrown arbrown arbrown approved these changes

@busunkim96 busunkim96 Awaiting requested review from busunkim96 busunkim96 was automatically assigned from googleapis/python-samples-owners

Assignees
No one assigned
Labels
api: logging Issues related to the googleapis/python-logging API. size: xl Pull request size is extra large. stale: old Pull request is old and needs attention.
Projects
None yet
Milestone
No milestone
Development

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