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

Move usage guides to their own docs. #6238

Merged
merged 4 commits into from
Oct 19, 2018
Merged

Conversation

tswast
Copy link
Contributor

@tswast tswast commented Oct 17, 2018

The API reference links were buried behind pages of
code samples. Moving the how-to guides to their own
pages makes the documentation easier to navigate.

@tswast tswast requested a review from alixhami October 17, 2018 17:27
@tswast tswast requested a review from crwilcox as a code owner October 17, 2018 17:27
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 17, 2018
@tswast tswast added api: bigquery Issues related to the BigQuery API. type: docs Improvement to the documentation for an API. labels Oct 17, 2018
@@ -1,408 +1,22 @@
.. include:: /../bigquery/README.rst

Using the Library

This comment was marked as spam.

This comment was marked as spam.

:start-after: [START bigquery_load_from_file]
:end-before: [END bigquery_load_from_file]

Load table data from Google Cloud Storage

This comment was marked as spam.

This comment was marked as spam.


.. code-block:: bash
More Examples
-------------

This comment was marked as spam.

bigquery/docs/index.rst Outdated Show resolved Hide resolved
`Datasets <https://cloud.google.com/bigquery/docs/datasets>`_.


Dataset operations

This comment was marked as spam.

This comment was marked as spam.

@tseaver
Copy link
Contributor

tseaver commented Oct 19, 2018

I have a question, rather than a direct review comment: would it be better to call the section usage than howto? Right now we have a page, /usage.html, which redirects to /index.html: that suggests that usage is part of the expected documentation pattern.

@tswast
Copy link
Contributor Author

tswast commented Oct 19, 2018

Would it be better to call the section usage than howto?

I chose howto because that's in line with our GCP tech writing style guide, but you're right that usage.html is the existing pattern in this library. Maybe I should move the subsections that I put in index.rst to their own usage/index.rst file?

The API reference links were buried behind pages of
code samples. Moving the how-to guides to their own
pages makes the documentation easier to navigate.
Add section headers to Dataset how-to guides.
@tswast tswast merged commit 9108464 into googleapis:master Oct 19, 2018
@tswast tswast deleted the bq-usage-docs branch October 19, 2018 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the BigQuery API. cla: yes This human has signed the Contributor License Agreement. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants