Documentation not accessible.聽#693
Copy link
Copy link
Closed
Labels
type: docsImprovement to the documentation for an API.Improvement to the documentation for an API.
Description
The documentation links are all redirected to this repository. The following links are from the readme
All of them redirect to https://github.com/googleapis/google-api-python-client
Even the links for the documentation on Google API client libraries redirects to this repo.
- https://developers.google.com/api-client-library/python/
- https://developers.google.com/api-client-library/python/start/get_started
- https://developers.google.com/api-client-library/python/samples/samples
Steps to reproduce
- Click on the links in the readme. All of them redirect to this repo.
Samples are actually here
https://github.com/googleapis/google-api-python-client/tree/master/samples
I couldn't find documentation similar to the one for java. Can you correct the links so that the documentation is accessible?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
type: docsImprovement to the documentation for an API.Improvement to the documentation for an API.
Activity
busunkim96 commentedon Jun 11, 2019
Hi @jerrythomas, we're in the process of removing documentation on that site, and have open issues on this repo to add documentation here.
Thank you for filing an issue!
doransmestad commentedon Jun 17, 2019
Any recommendations in the meanwhile? I'd like to use this project to interact with the Google APIs, but no available documentation makes this a bit challenging. Is there a place we can find the documentation while it is being migrated? Thanks
busunkim96 commentedon Jun 17, 2019
Hi @doransmestad, if you're looking for the generated ref docs they are currently available under:
https://googleapis.github.io/google-api-python-client/docs/dyn/{api_name}_{version}Examples:
https://googleapis.github.io/google-api-python-client/docs/dyn/accesscontextmanager_v1beta
https://googleapis.github.io/google-api-python-client/docs/dyn/customsearch_v1
For other docs (auth guide, for example), there are currently
PRsissues open on this repo that have the contents of those.We know this isn't ideal, and we're working on getting the GH pages site up to date.
Thank you all for your patience!
csudcy commentedon Jun 18, 2019
Hey @busunkim96, I had a look through PRs but couldn't see any which look like they're for adding docs; it looks like there are some recent merges which update docs though so maybe the links in the root readme just need updating?
@doransmestad in the meantime, I've found this sample most helpful: https://github.com/googleapis/google-api-python-client/blob/master/samples/appengine/
busunkim96 commentedon Jun 18, 2019
My mistake, the docs are currently in issues (labeled
type: docs) and all made on June 6th.Here's the App Engine one:
#688
docs: Adds docs folder. Fixes googleapis#669 Fixes googleapis#670 Fixes
grant commentedon Jun 26, 2019
With PR #706, I think we can close this and redirect developers to our new API
docs/pages! 馃帀https://github.com/googleapis/google-api-python-client/tree/master/docs
Pardon with the delay for moving these docs, and let up know if there's anything else we should do.
busunkim96 commentedon Jul 17, 2019
Should be closed with #702. There will be more cleanup in the future, but the docs are accessible again. Please see https://github.com/googleapis/google-api-python-client/blob/master/docs/README.md for a list of guides and reference documentation.