Add link for ux problems to the web site

knative / website

Hugo templates for the Knative website.

https://knative.dev

Other

23 stars 70 forks source link

Add link for ux problems to the web site #271

Open csantanapr opened 3 years ago

csantanapr commented 3 years ago

During the TOC meeting, this week @evankanderson suggested adding something on the website for users to open an UX issue

This is the Usability Issue Template

Currently, there is a link already Create a documentation issue

I'm wondering if adding an additional issue makes sense? I'm concern about being clutter or user confuse about which link to use. Is easier to have only one option sometimes

What do people think?

Add an additional link? What would be the text Have feedback? Open Usability Issue
No change? Monitor new doc issues for usability problems
Add a link in the new doc issue template stating if there is an usability problem to open an ux issue

csantanapr commented 3 years ago

@evankanderson @omerbensaadon

What do you think we should do?

csantanapr commented 3 years ago

/assign

omerbensaadon commented 3 years ago

It could just be a link below "Create documentation issue" that reads "Create user experience issue" ?

I worry about confusing users...

evankanderson commented 3 years ago

Agree that we don't want to be confusing...

Would it make sense to have just one issue link, but point it to a different repo/template depending on the page?

csantanapr commented 3 years ago

@evankanderson right now there is only one single partial for all the docs pages. is a global thing

evankanderson commented 3 years ago

I thought we could condition the partial on some front matter, but I didn't look at it deeply.

csantanapr commented 3 years ago

@evankanderson Here is the PITA

csantanapr commented 3 years ago

I was reading the kustomize docs and saw this. "Create project issue" Maybe this is what we use and send it to ux, and then we can take it from there and move the issue, easy to way to open an issue without the end-user learning about all the repos we have. https://kubectl.docs.kubernetes.io/blog/2019/10/24/v3.3.0/

pmbanugo commented 3 years ago

I would go for not having another link because it might be confusing which link to use. I prefer the text @csantanapr suggested Have feedback? Open Usability Issue or better IMO Have feedback? Open an Issue. I would change Edit this page to contribute to this page which can help with suggesting changes to the doc.

We can use multiple issue template on GitHub for Have feedback? Open an Issue if you'd like to separate it. One template for the documentation and the other for UX.

omerbensaadon commented 3 years ago

Does this page suck? Let us know!

Only half joking...

omerbensaadon commented 3 years ago

+1 to contribute to this page (even though I know most projects have "Edit this page" by default)