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

Clean up docs after section captions added #1035

Merged

Conversation

dhermes
Copy link
Contributor

@dhermes dhermes commented Aug 5, 2015

  • 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.

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.
@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
@@ -1,9 +1,5 @@
.. toctree::
:maxdepth: 0
:hidden:

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

@dhermes
Copy link
Contributor Author

dhermes commented Aug 5, 2015

@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?


Pub/Sub
-------

Client

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

@tseaver
Copy link
Contributor

tseaver commented Aug 5, 2015

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
Copy link
Contributor Author

dhermes commented Aug 5, 2015

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

@tseaver
Copy link
Contributor

tseaver commented Aug 5, 2015

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
Copy link
Contributor Author

dhermes commented Aug 5, 2015

@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
Copy link
Contributor

tseaver commented Aug 5, 2015

@dhermes that sounds right to me.

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
Copy link
Contributor Author

dhermes commented Aug 5, 2015

@tseaver PTAL

@tseaver
Copy link
Contributor

tseaver commented Aug 5, 2015

LGTM

dhermes added a commit that referenced this pull request Aug 5, 2015
…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
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants