Visitar URL original
Clean up docs after section captions added by dhermes · Pull Request #1035 · googleapis/google-cloud-python · GitHub
Skip to content

Clean up docs after section captions added - #1035

Merged
dhermes merged 4 commits into
googleapis:masterfrom
dhermes:clean-up-docs-after-section-captions-added
Aug 5, 2015
Merged

Clean up docs after section captions added#1035
dhermes merged 4 commits into
googleapis:masterfrom
dhermes:clean-up-docs-after-section-captions-added

Conversation

@dhermes

@dhermes dhermes commented Aug 5, 2015

Copy link
Copy Markdown
Contributor
  • Renaming some .rst docs since captions now hold headings.
  • Removing the out-of-date, hard to find _components/*-quickstart.rst as well.
  • Folded documentation for connections in client documentation, since we don't really ever need to talk about a connection without a client.
  • Folding in getting started doc into main index.rst.
  • Removing unused Makefile and components.

Fixes #1034.

dhermes added 2 commits August 5, 2015 10:43
@dhermes
Renaming some .rst docs since captions now hold headings.
f560c65 
Removing the out-of-date, hard to find _components/*-quickstart.rst
as well.

Folded documentation for connections in client documentation,
since we don't really ever need to talk about a connection
without a client.
@dhermes
Folding in getting started doc into main index.rst.
54d28ec
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 5, 2015
@dhermes dhermes added the docs label Aug 5, 2015
@dhermes dhermes mentioned this pull request Aug 5, 2015
Merged
dhermes
dhermes reviewed Aug 5, 2015
View reviewed changes
Comment thread docs/bigquery-usage.rst

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

@dhermes

dhermes commented Aug 5, 2015

Copy link
Copy Markdown
Contributor Author

@tseaver Regarding all your "Ditto" comments about removed documents, none of those were published in any place.

We can follow this up with usage docs or on-ramps for each sub-package?

tseaver
tseaver reviewed Aug 5, 2015
View reviewed changes
Comment thread docs/pubsub-client.rst Outdated

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

@tseaver

tseaver commented Aug 5, 2015

Copy link
Copy Markdown
Contributor

Re the _components fragments: if we don't need anything like them anywhere, then just dropping them is fine. FWIW, I have a feeling that trying to review docs as diffs is waaaay harder than reviewing software.

@dhermes

dhermes commented Aug 5, 2015

Copy link
Copy Markdown
Contributor Author

Maybe we should see how difficult it would be to use https://github.com/bslatkin/dpxdt for docs diffs?

@dhermes dhermes mentioned this pull request Aug 5, 2015
Closed
6 of 8 tasks
@tseaver

tseaver commented Aug 5, 2015

Copy link
Copy Markdown
Contributor

I'm less worried about how the changes look, and more about how hard it is to keep the overall context / usage paths straight in one's head, in order to make reasoned judgements about the changes.

@dhermes

dhermes commented Aug 5, 2015

Copy link
Copy Markdown
Contributor Author

@tseaver To confirm, these are the things to do:

  • Put Makefile back
  • Make page titles that are ambiguous also refer to the package they live in

@tseaver

tseaver commented Aug 5, 2015

Copy link
Copy Markdown
Contributor

@dhermes that sounds right to me.

dhermes added 2 commits August 5, 2015 14:20
@dhermes
Removing unused components.
bd8bcbc
@dhermes
Adding clarifying (by package) page titles where needed.
f9427af 
Stilling preserving the short name in the toctree.

Also adding trailing newlines to all .rst files that\
didn't have it (this was a side-effect of my editor,
but not a bad one).
@dhermes
dhermes force-pushed the clean-up-docs-after-section-captions-added branch from 17676f9 to f9427af Compare August 5, 2015 21:32
@dhermes

dhermes commented Aug 5, 2015

Copy link
Copy Markdown
Contributor Author

@tseaver PTAL

@tseaver

tseaver commented Aug 5, 2015

Copy link
Copy Markdown
Contributor

LGTM

dhermes added a commit that referenced this pull request Aug 5, 2015
@dhermes
Merge pull request #1035 from dhermes/clean-up-docs-after-section-cap…
73f1a2d 
…tions-added

Clean up docs after section captions added
@dhermes
dhermes merged commit 73f1a2d into googleapis:master Aug 5, 2015
@dhermes
dhermes deleted the clean-up-docs-after-section-captions-added branch August 5, 2015 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dhermes @tseaver @googlebot