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

Adds initial documentation. #49

Merged
merged 8 commits into from
May 25, 2023
Merged

Adds initial documentation. #49

merged 8 commits into from
May 25, 2023

Conversation

edonehoo
Copy link
Contributor

Makes progress on #21 and GH documentation.


![Image of feedback options in a wizard](/packages/module/patternfly-docs/content/img/wizard-selection.png)

By default, user feedback can point users to 2 Qualtrics forms: a [feedback form](https://console.redhat.com/self-managed-feedback-form), which asks users to offer feedback on their product experience, and a [research form]( https://console.redhat.com/self-managed-research-form), which asks users if they’d like to participate in future research with Red Hat’s User Experience Design team.
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably change this to describing how they have the option to use URLs, or make network calls. The user has to provides these URLs for a form they want to access. The examples where just using qualtrics form.

I will open an issue to change this to some other form that's not related to redhat.

Copy link

@andybraren andybraren left a comment

Choose a reason for hiding this comment

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

Thank you for getting this rolling @edonehoo, and apologies for dragging my feet.

This is a great start! Here are a few small suggestions, and some things we could potentially remove if my understanding is correct.

There might not be too much else to document in the design guidelines for this Extension. Maybe including 1 additional screenshot of this modal with a form in it (like when "Share feedback" is clicked) could be a helpful example for folks to see, but aside from that, I think this is pretty close to ready!

Thanks again! 🙏


![Image of feedback options in a wizard](/packages/module/patternfly-docs/content/img/wizard-selection.png)

By default, user feedback can point users to 2 Qualtrics forms: a [feedback form](https://console.redhat.com/self-managed-feedback-form), which asks users to offer feedback on their product experience, and a [research form]( https://console.redhat.com/self-managed-research-form), which asks users if they’d like to participate in future research with Red Hat’s User Experience Design team.

Choose a reason for hiding this comment

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

Suggested change
By default, user feedback can point users to 2 Qualtrics forms: a [feedback form](https://console.redhat.com/self-managed-feedback-form), which asks users to offer feedback on their product experience, and a [research form]( https://console.redhat.com/self-managed-research-form), which asks users if they’d like to participate in future research with Red Hat’s User Experience Design team.
The feedback modal includes a title, description text, an image, and one or more selectable ways to provide feedback. Each of these can be individually customized.
Each option can either link to an external URL that opens as a separate tab, or display a form in the modal that can submit its data over the network.

Tweaked this a bit to clarify what Don mentioned.

@dlabaj are the 3 different forms you've built (Share feedback, Report a bug, and Inform the direction of ) standard, fixed things in the Extension? Or are they basically just examples of forms that people can replace with whatever kind of form they want? Just wondering if the contents of each one needs to be documented and included here or not.

And anyone please correct me if I'm wrong, but as much as I'd like to be able to point readers from Red Hat to the URLs we've standardized on internally for on-premise products to use, my understanding is that the PatternFly community site should be vendor agnostic. We may need to figure out an alternative place for Red Hatters to find these two key links in that case... (@andrew-ronaldson 👀)


By default, user feedback can point users to 2 Qualtrics forms: a [feedback form](https://console.redhat.com/self-managed-feedback-form), which asks users to offer feedback on their product experience, and a [research form]( https://console.redhat.com/self-managed-research-form), which asks users if they’d like to participate in future research with Red Hat’s User Experience Design team.

To reveal a user’s path to the form, “source” and “feature” query parameters are passed through to the destination URL. For example, “?source=openshift&feature=vm-wizard reveals that a user accessed user feedback through a wizard component in OpenShift. These parameters can be used in combination with Qualtrics filters to adjust a form’s questions and messaging based on a user’s source, instead of requiring the creation of separate forms for each possible user source.

Choose a reason for hiding this comment

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

Suggested change
To reveal a user’s path to the form, “source” and “feature” query parameters are passed through to the destination URL. For example, “?source=openshift&feature=vm-wizard reveals that a user accessed user feedback through a wizard component in OpenShift. These parameters can be used in combination with Qualtrics filters to adjust a form’s questions and messaging based on a user’s source, instead of requiring the creation of separate forms for each possible user source.

sighs and 👀's @andrew-ronaldson again 😄

@edonehoo
Copy link
Contributor Author

FYI - I don't currently have edit access to Sketch, which is required to add the pink annotation tags to the images. I'm working on getting that granted

Copy link
Contributor

@dlabaj dlabaj left a comment

Choose a reason for hiding this comment

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

lgtm

@dlabaj dlabaj merged commit 2437f50 into patternfly:main May 25, 2023
@github-actions
Copy link

🎉 This PR is included in version 5.0.0-alpha.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

3 participants