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

Zappa needs Sphinx docs on ReadTheDocs.org #243

Open
bjinwright opened this issue Aug 12, 2016 · 7 comments
Open

Zappa needs Sphinx docs on ReadTheDocs.org #243

bjinwright opened this issue Aug 12, 2016 · 7 comments
Assignees

Comments

@bjinwright
Copy link
Collaborator

I aim to make that happen.

@bjinwright bjinwright self-assigned this Aug 12, 2016
@bjinwright
Copy link
Collaborator Author

@jotes
Copy link
Contributor

jotes commented Aug 17, 2016

@bjinwright I think we can close this one 👍

@Miserlou
Copy link
Owner

Miserlou commented Aug 17, 2016

Leave this open until we have documentation on how to contribute/compile/publish the docs please! (I don't know..)

@bxm156
Copy link
Contributor

bxm156 commented Oct 16, 2017

Was thinking, should we just delete the /docs so that user's don't get confused? Sounds like the README is place for documentation.

@aehlke
Copy link
Contributor

aehlke commented Oct 16, 2017

@bxm156 I attempted to move in the other direction here #410 so going the other way and deleting /docs sounds good. Do we have anything in /docs that needs to get backported though?

@bxm156
Copy link
Contributor

bxm156 commented Oct 16, 2017

@aehlke The last notable change to /docs was in Mar 23, 2017. Some of them were last touched a year ago, and they aren't being published on readthedocs.org either.

I don't think there is anything in them that needs backported, I'd say the goto place for documentation has always been the readme. In fact, some of the documentation in /docs is so old that it simply just incorrect for today's version of zappa. @bjinwright did some work on the /docs so he might have some thoughts on this.

@bxm156
Copy link
Contributor

bxm156 commented Oct 17, 2017

I think there are a few examples for DNS/domain setup in /docs that are linked to from the README. I think we can just integrate them in to the README

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

No branches or pull requests

5 participants