Skip to content

Add get in touch section #3646

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

Merged
merged 10 commits into from
Jun 7, 2018
Merged

Conversation

raybellwaves
Copy link

Added a get in touch section so first timers like me know where to ask questions.
If you have a forum/mailing list/google group this could also be added here.

Cheers,
Ray

@stsewd
Copy link
Member

stsewd commented Feb 21, 2018

There is gitter https://gitter.im/rtfd/readthedocs.org and #readthedocs on IRC

@stsewd
Copy link
Member

stsewd commented Feb 21, 2018

I think would be better to add to the docs, and add a link to there from the readme

@raybellwaves
Copy link
Author

raybellwaves commented Feb 21, 2018

Had a quick go at putting it the docs. Will the get in touch page be build automatically? I could add the link for the page once it exists. You're welcome to make any changes you seem fit to this. For example I left out the IRC because i'm not familiar with that

@ericholscher
Copy link
Member

Not sure this should go in a new page in the docs, but be incorporated into the existing contributing page: http://docs.readthedocs.io/en/latest/contribute.html

@stsewd
Copy link
Member

stsewd commented Feb 21, 2018

As Eric mention, that would be better on the contribute page, the link generated would be something like https://docs.readthedocs.io/en/latest/contribute.html#get-in-touch

About IRC, you can put something like: On IRC find us at #readthedocs on irc.freenode.org.

@RichardLitt RichardLitt added the PR: work in progress Pull request is not ready for full review label Feb 21, 2018
@raybellwaves
Copy link
Author

I couldn't quite work out how to code the #readthedocs bit for IRC. I'm also not sure about the get-in-touch.html in README.rst.

You may want to decide where you want 'how do i?' questions asked? In the contributing docs I noticed you mention opening up a ticket on Github and I see there is a support label used. But you do have a StackOverflow question tag which may help filter out questions from bugs and feature requests in the Github issues.

This PR started as I asked a question on SO (https://stackoverflow.com/questions/48878411/readthedocs-build-failing-using-aiohttp) but it currently only has 4 views and therefore wonder if I should have put it on the issues.

@agjohnson
Copy link
Contributor

The IRC link should work as expected. Usually it's enough to say #readthedocs on freenode, I'm not sure if the irc:// link is useful for most. This is fine though, it should work well.

We prefer bugs end up on GitHub, and ideally, the RTD and Sphinx community can collectively help solved usage problems around RTD/Sphinx on Stack Overflow (the core team makes no effort to answer questions here). I believe we mention this somewhere else in our docs, perhaps on our open source philosophy page. I think we need to communicate that the core team can't really handle support requests around usage.

@raybellwaves
Copy link
Author

Thanks

@brainwane
Copy link
Contributor

A useful IRC link is https://webchat.freenode.net/?channels=%23readthedocs which lets people visit the channel in the browser, without having to install IRC software.

@RichardLitt
Copy link
Member

What @brainwane suggests is also what @ipfs uses in their repos.

@ericholscher ericholscher merged commit bebb7e6 into readthedocs:master Jun 7, 2018
@ericholscher
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: work in progress Pull request is not ready for full review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants