-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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 abound in SD docs #2246
Comments
You might have a better time at Read the Docs. |
How would I find that link you supplied? The links I pasted above are what is linked off the front page of https://github.com/GoogleCloudPlatform/gcloud-python for "API documentation" - readthedocs.io is nowhere to be found as a link from here... The docs on github are also where the big read "Read the Docs" link from https://googlecloudplatform.github.io/gcloud-python/#/ takes you, which is doubly confusing given the name of the link doesn't actually link to readthedocs.io... :) Searching for [gcloud python docs] or [gcloud python documentation] doesn't provide any hint of readthedocs.io either. I appreciate the pointer in the meantime, it does help, but it also means the situation is even worse than I thought initially! |
Thanks for reporting @mattbnz! I think we should put the readthedocs link in the README.md. The googlecloudplatform.github.io/gcloud-python docs are currently a work inprogress. They were just converted to an auto generated platform and there are edge cases that continue to pop up. I'll see if I can figure this one out and I'll post back if I find the issue. |
I'm going to close this for now since we switched back to sphinx documentation. |
Follow up to googleapis#3316. Fixes googleapis#2246.
I'm trying to read the docs for the SD monitoring API. Broken links abound.
I'm starting at: https://googlecloudplatform.github.io/gcloud-python/#/docs/master/gcloud/monitoring
I click on the link for details about "Monitored Resource Descriptors" which hover says will go to https://googlecloudplatform.github.io/gcloud-python/#/docs/master/gcloud/monitoring/index/resourcedescriptor but my browser actually ends up at https://googlecloudplatform.github.io/gcloud-python/#/docs/master/gcloud which has no content.
I hit back and figure I'll just look at the source since the docs are broken, so I hit "Source Code" down the bottom of the original page, which takes me to https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/ which is a complete 404 served by github.
The text was updated successfully, but these errors were encountered: