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 community support to email #5651

Merged

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented May 1, 2019

With the aim of keeping the issue tracker related to code issues,
and have a more control over specific request.
We are moving admin-only actionable request to email.

I found these places only, not sure if anything else is missing or if we are pointing to the correct email :)

With the aim of keeping the issue tracker related to code issues,
and have a more control over specific request.
We are moving admin-only actionable request to email.
@stsewd stsewd requested a review from a team May 1, 2019 22:54
@agjohnson
Copy link
Contributor

There is also our build error warning that automatically opens an issue on GitHub. Do you think we want to change that as well?

@stsewd
Copy link
Member Author

stsewd commented May 1, 2019

@agjohnson I don't think that's convenient for the users or us. Why? If keeps the knowledge of how to fix x public or current problems. Also, we will have emails of the same error, when maybe there is an issue where users can search for the solution. Or when we break the builders, we will get a lot of emails, in an issue a user can just report the problem in the same thread.

@agjohnson
Copy link
Contributor

agjohnson commented May 1, 2019

I'm talking about the generic failure case, which should only be for unknown errors that are raised in the build process. It's almost always going to be a support request that involves us looking up information and the user can't really self remedy these errors.

For example, the error that lists the build id and we have to go into Sentry to fish out the actual cause.

@stsewd
Copy link
Member Author

stsewd commented May 2, 2019

Personally I think that half of those generic errors are because something is wrong from our side (like #5653 (comment)), and those should go in the issue tracker. We have some other issues related to memory consumption that can lead to the same problem (the other half).

@agjohnson
Copy link
Contributor

They should end up as proper issues if there is something we want to fix, yeah.

But that doesn't necessarily mean that the support request needs to be an issue itself -- the issue you linked would be hard for anyone else to find or get value out of, and it effectively separates that request from the rest of our support requests.

Generic support suggestions like this could go to our support queue, and from there we decide if they are an issue we should be working on improving (open a linked github issue), or if they are not worth our time to develop a fix for (resolve and close the support request).

@stsewd
Copy link
Member Author

stsewd commented May 9, 2019

I feel like we are going to get flooded if we link from a general failure to email. Most of them are problems in our side, like not catching the appropriate error or raising a different error.

We could just test how it goes with the current support and then link from general failures to email.

@humitos
Copy link
Member

humitos commented May 20, 2019

I agree with Anthony on this: pointing the generic error to the issue tracker gives nothing useful to the next person with "the same problem". Those issues are usually on our side and they need to check sentry, logs, etc to debug a little --the user can take no action on these ones. Then, if it's something that needs to be fixed, we (the Core Team) can open an issue here.

I'd change that link to become a mailto: with subject and a body instead of an issue. This will help us to have all the support requests in the same place.

Besides, I think we can modify the GitHub issue template mentioning that support requests are managed by email.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good change. We can address the other additions later, but let's ship this since it's done 👍

@ericholscher ericholscher merged commit fd2d720 into readthedocs:master Jun 5, 2019
@stsewd stsewd deleted the move-community-requests-to-email branch June 5, 2019 23:29
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

Successfully merging this pull request may close these issues.

4 participants