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

Reference docs link to 404 docs/_static/guide-me.svg #1303

Closed
bcoe opened this issue Jul 4, 2022 · 2 comments · Fixed by #1306 or #1302
Closed

Reference docs link to 404 docs/_static/guide-me.svg #1303

bcoe opened this issue Jul 4, 2022 · 2 comments · Fixed by #1306 or #1302
Assignees
Labels
api: logging Issues related to the googleapis/nodejs-logging API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@bcoe
Copy link
Contributor

bcoe commented Jul 4, 2022

Reference documentation links to docs/_static/guide-me.svg which is a 404, this is most likely caused by a bad JSDoc string.

@bcoe bcoe added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Jul 4, 2022
@product-auto-label product-auto-label bot added the api: logging Issues related to the googleapis/nodejs-logging API. label Jul 4, 2022
@daniel-sanche
Copy link
Contributor

It sounds like @arbrown may have some context on this

@arbrown
Copy link
Contributor

arbrown commented Jul 11, 2022

I'm not sure what the issue is here. I added the button to the docs, and I remember there was some issue with jsdoc not copying it to the correct folder because it was an svg and not a png, but it seemed to be solved by adding a separate copy of the image in a nested directory so there were two copies instead of one. See #1262 and the passing run of the docs check (including linkinator finding docs/_static/guide-me.svg).

Indeed, the button appears to be showing up both on github and npmjs as intended.

image

image

At this point, in order to fix the tests, I can propose two potential solutions:

  1. Change the image ref to a fixed URL like https://raw.githubusercontent.com/googleapis/nodejs-logging/main/_static/guide-me.svg
  2. Just remove the images entirely and change the link to plain text

What do you think?

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/nodejs-logging API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
4 participants