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

The "Create documentation issue" should add more context to generated issue

Open chalin opened this issue 1 year ago • 4 comments

Originally posted by @svrnm in https://github.com/open-telemetry/opentelemetry.io/issues/3929#issuecomment-1924585621

As a minor, related point: I created this issue by clicking on the "Create documentation issue" link within the documentation. I assumed (wrongly) that it would automatically provide you the context/page link when I did that. Probably others will make the same assumption. Thanks, Oliver.

Thanks for calling this out, GitHub allows to send some properties with a new issue link, maybe that can be added to those links, cc @chalin

chalin avatar Feb 03 '24 12:02 chalin

Something like this?

https://github.com/open-telemetry/opentelemetry.io/issues/new?assignees=&labels=bug&projects=&template=DOCS_UPDATE.md&title=Issue in {{ .Path }}{{ .Filename }}

https://gohugo.io/methods/page/file/

theletterf avatar Feb 05 '24 09:02 theletterf

Yes, something like that. I know that I implemented something like this for one of the projects, let me dig that up.

chalin avatar Feb 06 '24 16:02 chalin

I'd give this one a try if you want!

theletterf avatar Feb 16 '24 08:02 theletterf

Through a local layout override or through the Docsy repo?

You can surely give it a try though there's work planned (https://github.com/google/docsy/issues/1841) for the next release of Docsy that should make this issue much easier to address -- so it might be more effective to wait until then.

chalin avatar Feb 16 '24 17:02 chalin