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

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

Open
Tracked by #5137
chalin opened this issue Feb 3, 2024 · 4 comments
Open
Tracked by #5137
Assignees
Labels
docsy e0-minutes Effort: < 60 min

Comments

@chalin
Copy link
Contributor

chalin commented Feb 3, 2024

Originally posted by @svrnm in #3929 (comment)

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 chalin self-assigned this Feb 3, 2024
@chalin chalin added e0-minutes Effort: < 60 min docsy labels Feb 3, 2024
@chalin chalin mentioned this issue Feb 3, 2024
@theletterf
Copy link
Member

theletterf commented Feb 5, 2024

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/

@chalin
Copy link
Contributor Author

chalin commented Feb 6, 2024

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

@theletterf
Copy link
Member

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

@chalin
Copy link
Contributor Author

chalin commented Feb 16, 2024

Through a local layout override or through the Docsy repo?

You can surely give it a try though there's work planned (google/docsy#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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsy e0-minutes Effort: < 60 min
Projects
None yet
Development

No branches or pull requests

2 participants