opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

Add feedback form and ToC link from Docsy theme to docs pages

Open theletterf opened this issue 1 year ago • 4 comments

Desired feature or idea: What would you like to see happen?

As discussed in the last SIG meeting, we'd like to add Docsy's feedback widget and repo link (create issue) to our site:

  • [x] https://www.docsy.dev/docs/adding-content/feedback/#user-feedback - #4772
  • [ ] https://www.docsy.dev/docs/adding-content/repository-links/

theletterf avatar Jul 01 '24 17:07 theletterf

Thanks @theletterf for creating the issue. I suggest tackling the subtasks separately.

chalin avatar Jul 01 '24 21:07 chalin

@chalin Seems like repo links appeared automagically after #4772 got merged!

We'd consider customizing the icon or the issue title text though -- just the title seems overly basic to me.

theletterf avatar Jul 02 '24 09:07 theletterf

I wonder if we could combine that feedback form with a github issue form. I played with them for the community repo a while back and they allow you to provide a more structured issue creation, i.e. you can make things mandatory or provide input fields, etc. WDYT?

svrnm avatar Jul 03 '24 18:07 svrnm

Hmm, I like that idea!

chalin avatar Jul 04 '24 16:07 chalin

Cross-referencing a relevant Docsy issue:

  • https://github.com/google/docsy/issues/2054

chalin avatar Jul 11 '24 22:07 chalin

Given the discussion in https://cloud-native.slack.com/archives/C06EDFPQ5EH/p1724142213551189, I've created the following issue and reexplained why this hasn't been implemented yet:

  • #5091

Closing this issue now since the website has page-feedback forms enabled. Adjusting the issue title, etc., is in scope of #5091.

chalin avatar Aug 22 '24 19:08 chalin