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.

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

docs: Change button in README to .png file #554

Merged
merged 2 commits into from May 22, 2022
Merged

docs: Change button in README to .png file #554

merged 2 commits into from May 22, 2022

Conversation

arbrown
Copy link
Contributor

@arbrown arbrown commented May 20, 2022

* Change the "Guide Me" button to a .png file to work with RST `image`
* Avoids `raw` directive disabled by PyPi
* Fixes #553
@arbrown arbrown requested review from a team as code owners May 20, 2022 16:36
@product-auto-label product-auto-label bot added size: xs Pull request size is extra small. api: logging Issues related to the googleapis/python-logging API. labels May 20, 2022
@arbrown arbrown added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label May 20, 2022
Add copy of png file to render correctly in GitHub
readme and Sphinx generated docs.
@arbrown arbrown removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label May 20, 2022
@daniel-sanche
Copy link
Contributor

Isn't README.rst a template controlled by owlbot? It would probably be better to change the template directly, and let the change be propagated to all libraries

@arbrown arbrown added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 20, 2022
@arbrown
Copy link
Contributor Author

arbrown commented May 20, 2022

I think README is controlled by Owlbot in other Repos, but not in this one. I was previously able to modify the README.rst in #541, and I don't see Owlbot anywhere in the file history.

This change doesn't apply to other repositories anyway. If there is a template/config that lets me insert custom content for just this repo (like in the nodejs repo, I can do that, but I don't see such a 'partials' file for this repo.

@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 20, 2022
@daniel-sanche
Copy link
Contributor

Hmm you're right, it looks like this file is in the ignored list for owlbot. LGTM!

@parthea parthea changed the title fix: Change button to .png file docs: Change button in README to .png filehttps://github.com/googleapis/python-logging/pull/554/files#submit-review May 22, 2022
@parthea parthea changed the title docs: Change button in README to .png filehttps://github.com/googleapis/python-logging/pull/554/files#submit-review docs: Change button in README to .png file May 22, 2022
@parthea parthea merged commit e297747 into main May 22, 2022
@parthea parthea deleted the 553-fix branch May 22, 2022 18:26
arbrown added a commit that referenced this pull request May 23, 2022
* fix: Change button to .png file

* Change the "Guide Me" button to a .png file to work with RST `image`
* Avoids `raw` directive disabled by PyPi
* Fixes #553

* Fix unexpected unindent in docs

Add copy of png file to render correctly in GitHub
readme and Sphinx generated docs.
arbrown added a commit that referenced this pull request Jul 11, 2022
* Add .python-version to .gitignore

* Add initial class/test for instrumentation_source

* Add version and truncate logic

* Add instrumentation tests and severity info

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Add method to update and validate existing info

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Add .python-version to gitignore

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Implement hook to add instrumentation for logger

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Add tests for logger instrumentation logic

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Update structured log handler to emit info

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Refactor structured log and add unit test

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Add side effect to unit test

* Ensure that instrumentation info is only called once

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Update to environment submodule

* Fix linter errors

* chore(main): release 3.1.0 (#479)

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

* docs: Change button in README to .png file (#554)

* fix: Change button to .png file

* Change the "Guide Me" button to a .png file to work with RST `image`
* Avoids `raw` directive disabled by PyPi
* Fixes #553

* Fix unexpected unindent in docs

Add copy of png file to render correctly in GitHub
readme and Sphinx generated docs.

* chore(main): release 3.1.1 (#557)

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

* Update env-tests submodule

* Minor format update

* Fix system test to skip diagnostic log entry

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Update truncation logic based on feedback

* Update environment tests

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Fix broken unit test

* Fix broken unit test

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Change default name/version

* Refactor add_instrumentation

Return a new list instead of a mutated original
Do not return after first log without info

* Add more documentation to validation methods

* Refactor add_instrumentation to be more pythonic

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Update environemnt tests

* Refactor _is_valid and add test

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Add more detail to method documentation

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Move methods to private

* Change instumentation_added to private

* Fix some issues with validation method

Add a test

* Fix bug in _add_instrumentation

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Simplify string truncation

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Remove unused import to fix lint

* Remove validate_and_update_instrumentation

Simplify code by adding a single instrumentation entry
instead of validating potential existing entries

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Remove _is_valid code (no longer checked)

* Run nox blacken

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Remove extraneous unit test

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Daniel Sanche <d.sanche14@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: logging Issues related to the googleapis/python-logging API. size: xs Pull request size is extra small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warning: a recent release failed
4 participants