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

add feedback widget to bottom of docs #11037

Merged
merged 1 commit into from Nov 20, 2018

Conversation

@kaycebasques
Contributor

kaycebasques commented Nov 17, 2018

Adds a "Feedback" section to the bottom of each doc page:

image

Clicking "Yes" or "No" disables those buttons and then shows a response with a call-to-action to get help on Stack Overflow or leave more feedback:

image

The data should be reported to Google Analytics as events, but I don't have access to your account so I can't verify. The same workflow is used on developers.google.com/web. See Access the data. Looking at that section now, I might need to add more screenshots to help clarify the workflow for accessing the data. So if you get stuck on those instructions, it's my fault.

image

When you don't want the feedback widget on a particular page, you just add the hide_feedback: true property to the page's front matter. I'm assuming that this will be a rare situation, hence this default approach of including the feedback widget unless explicitly told otherwise.

Note that I omitted the widget from the homepage because the browse.html partial that the homepage includes was causing the feedback widget to show up in a weird place. I tried working around this, but eventually decided that the current approach is probably good enough for the vast majority of pages. And you may not want a feedback widget on the homepage, anyways.

@k8s-ci-robot

This comment has been minimized.

k8s-ci-robot commented Nov 17, 2018

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@kaycebasques

This comment has been minimized.

Contributor

kaycebasques commented Nov 17, 2018

/assign @chenopis

@k8sio-netlify-preview-bot

This comment has been minimized.

Collaborator

k8sio-netlify-preview-bot commented Nov 17, 2018

Deploy preview for kubernetes-io-master-staging ready!

Built with commit a109caf

https://deploy-preview-11037--kubernetes-io-master-staging.netlify.com

@kaycebasques

This comment has been minimized.

Contributor

kaycebasques commented Nov 17, 2018

Seems like the CLA should be good now...

image

@kaycebasques

This comment has been minimized.

Contributor

kaycebasques commented Nov 17, 2018

Nice, looks like that last comment triggered k8s-ci-robot to check again.

I browsed its commands and gotta see what this does...

/joke

@k8s-ci-robot

This comment has been minimized.

k8s-ci-robot commented Nov 17, 2018

@kaycebasques: What do you call a fly without wings? A walk.

In response to this:

Nice, looks like that last comment triggered k8s-ci-robot to check again.

I browsed its commands and gotta see what this does...

/joke

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@chenopis chenopis requested review from lucperkins, zacharysarah and Bradamant3 and removed request for xiangpengzhao and Rajakavitha1 Nov 20, 2018

@chenopis

This comment has been minimized.

Contributor

chenopis commented Nov 20, 2018

This is great @kaycebasques !

I'm seeing the clicks go through to the Google Analytics accounts (see below), so I think we're all good. I'll add you as view-only to the metrics as well so you can double check them when it goes live.

screen shot 2018-11-20 at 8 53 14 pm

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm label Nov 20, 2018

@chenopis

This comment has been minimized.

Contributor

chenopis commented Nov 20, 2018

@zacharysarah @Bradamant3 @lucperkins I checked the preview build and Google Analytics. LGTM, so I'll leave it to one of you to approve it so it can get merged.

@chenopis chenopis added this to the Analytics milestone Nov 20, 2018

@Bradamant3

This comment has been minimized.

Member

Bradamant3 commented Nov 20, 2018

/approve

But we should have as a fast follow fixing up the topic type landing pages: the tasks landing page, for example, we've agreed is useless. We don't need more people telling us so (assuming they bother ;))

@k8s-ci-robot

This comment has been minimized.

k8s-ci-robot commented Nov 20, 2018

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bradamant3

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 59c4712 into kubernetes:master Nov 20, 2018

4 checks passed

cla/linuxfoundation kaycebasques authorized
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details
tide In merge pool.
Details

vladimirvivien added a commit to vladimirvivien/kubernetes.github.io that referenced this pull request Nov 20, 2018

@kaycebasques

This comment has been minimized.

Contributor

kaycebasques commented Nov 20, 2018

Thank you for the reviews.

@Bradamant3 I'd argue that even if you don't get around to updating those topic type landing pages right away, you'll still be gathering useful data. After you update them, you'll be able to compare the old ratings to the new.

@kaycebasques kaycebasques deleted the kaycebasques:feedback branch Nov 20, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment