Add email link on pip's documentation

[nlhkabu]

What?
We want to add a way for users to give feedback on the pip docs, while they are using them.

Why?
Our goal is to understand what problem the user is trying to solve, what information is helpful, what is unhelpful, and what is missing. Understanding this will help us improve the pip docs for future users.

How?
Initially, we want to add an email link to each documentation page to encourage users to provide us with feedback. This should be a standout box, and contain a message that is something like this:

Did this article help?

We are currently doing research to improve pip's documentation and would love your feedback.
Please email us and let us know:

1. What problem were you trying to solve when you came to this page?
2. What content was useful?
3. What content was not useful?

Where?
It would be great to include this message either:

• At the end of each article
• As a "sticky" message either at the top or right hand side of the page

[nlhkabu]

ping @jdittrich for feedback on the message.
Note: it would be great for the email link to include the questions we want answered in the email body.

[nlhkabu]

@webknjaz or @yeraydiazdiaz - would either of you have time to work on this? I'd like to start collecting data asap.

[webknjaz]

@nlhkabu would something like https://sphinx-version-warning.rtfd.io work?

[jdittrich]

@webknjaz
Is this the banner that would hold the email link?

@webknjaz @nlhkabu
I think it would be preferable to have it in the sidebar, as people might want to give feedback on something they deal with when having scrolled down. Alternatively: Could the banner appear at the bottom of the page? (I guess there it is more likely that the participants already made some experiences with the text and could give feedback on it, whereas, if the banner is on top, they need to remember to give feedback later while solving their problem (or whatever they consult the docs for))

[webknjaz]

Is this the banner that would hold the email link?

Yes, but if not — making a sticky header shouldn't be too hard.

I think it would be preferable to have it in the sidebar

As in, under the left menu?

FWIW this issue looks like a temporary solution so I'd avoid investing too much time into it knowing that it'll be replaced.

[nlhkabu]

@webknjaz @jdittrich how about a compromise. We include the header at the top and the bottom of the page?
As @webknjaz mentioned, it's a temporary fix, so I don't think we should invest too much time in it.

@jdittrich are you happy with this text?

Did this article help?

We are currently doing research to improve pip's documentation and would love your feedback.
Please email us and let us know:

1. What problem were you trying to solve when you came to this page?
2. What content was useful?
3. What content was not useful?

I will confirm email address ASAP.

[jdittrich]

We include the header at the top and the bottom of the page?

Yes, good compromise :)

[georgiamoon]

Email address has been created: docs-feedback@pypa.io !