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

broken links in AUTHENTICATION guides on googleapis.dev #5185

Closed
TheRoyalTnetennba opened this issue Mar 27, 2020 · 4 comments · Fixed by googleapis/synthtool#462
Closed
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@TheRoyalTnetennba
Copy link
Contributor

Synthtool generates an authentication guide for each library, AUTHENTICATION.md. These authentication guides reference a TROUBLESHOOTING.md that is not generated by synthtool. There are a lot of libraries that don't have a TROUBLESHOOTING.md, which is causing broken links on both the repo's markdown, and on googleapis.dev.

Examples:

  1. google-cloud-monitoring's authentication guide, which at the very bottom references a troubleshooting doc which 404s
  2. The authentication guide for google-cloud-datastore has a 200 link for troubleshooting.
@TheRoyalTnetennba TheRoyalTnetennba added the type: docs Improvement to the documentation for an API. label Mar 27, 2020
@dazuma
Copy link
Member

dazuma commented Mar 30, 2020

We should just remove the troubleshooting link from the template for now. (Note: the microgenerator-generated authentication guides don't have the troubleshooting link because they don't generate a troubleshooting doc.)

@quartzmo
Copy link
Member

I re-ran the kokoro job for #5215 and still get the same error:

http://localhost:5249/file.AUTHENTICATION.html
  [404] http://localhost:5249/file.TROUBLESHOOTING.html
...
ERROR: Detected 1 broken links. Scanned 141 links in 2.134 seconds.
doc contains the following broken links:
  [404] http://localhost:5249/file.TROUBLESHOOTING.html
    [404] http://localhost:5249/file.TROUBLESHOOTING.html

google-cloud-bigquery-data_transfer tests took 16 seconds


[ID: 4502577] Build finished after 261 secs, exit value: 1


Warning: Permanently added 'localhost' (ECDSA) to the list of known hosts.
[12:33:26] Collecting build artifacts from build VM
Build script failed with exit code: 1

Do we need to close it and similar PRs for regen?

@quartzmo quartzmo reopened this Mar 31, 2020
@dazuma
Copy link
Member

dazuma commented Mar 31, 2020

Oh, we need to rerun synth on the affected libraries for this to take effect and remove the broken links.

@dazuma
Copy link
Member

dazuma commented Mar 31, 2020

Reran synth. These should be fixed now. (There are other issues, but will open separate issues for them.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants