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

API documentation: some fixes #87

Merged
merged 8 commits into from Oct 27, 2020

Conversation

KilimAnnejaro
Copy link
Collaborator

@KilimAnnejaro KilimAnnejaro commented Oct 24, 2020

Intro fixes to some of the documentation in the API area. I wanted to simplify the main API landing page as well as remove the API key setup docs, which are not needed at this time. Feedback welcome!

1. **Pandas** APIs for use in Python notebooks
1. **Google Sheets** APIs for use in Google Sheets
1. **Python** APIs
1. **SQL** (Coming soon)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per https://developers.google.com/style/future, removing future feature documentation. (If needed, I can write up a blog post for roadmap if that would be helpful.)

@@ -3,6 +3,7 @@ layout: default
title: Setting up the API
parent: API
nav_order: 1
published: false
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of this documentation relates to API key setup, which is not needed at this time.

1. **Google Sheets** APIs for use in Google Sheets
1. **Python** APIs
1. **SQL** (Coming soon)
The **Data Commons API** allows developers to programmatically access the data in Data Commons.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very well written. I just wonder if it's helpful to users to see the different endpoints highlighted (maybe at least bold/italics if we want to remove the bullet points)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe even with links to the docsite pages for each endpoint

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed the docs per this suggestion. Let me know what feels best to you!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

@tjann tjann merged commit 792c446 into datacommonsorg:master Oct 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants