Add GitHub file path of .qmd when reporting an issue

[ShKlinkenberg]

Description

I love the feature in all html based quarto files to add a "Report an issue" link on all pages. If you click on this link, a GitHub issue is created with a blank description box. It would be great if the GitHub path of the .qmd file could be added automatically to the description box.

This would make resolving issues more targeted. Would this be something that could be implemented?

[cscheid]

It depends on whether GitHub supports this, and I don't know whether it does. We can only communicate with GitHub via the URL that users click. See, for example, https://quarto.org/docs/manuscripts/publishing.html

The two links are:

• "Edit this page": https://github.com/quarto-dev/quarto-web/edit/main/docs/manuscripts/publishing.qmd
• "Report an issue": https://github.com/quarto-dev/quarto-cli/issues/new/choose

Because GitHub's new issue flow can be quite complicated (and can depend on the repo), I don't think it's straightforward to communicate the filename through the URL into their interactive UI flow. If you want to investigate that for us and report, that would be appreciated, but we honestly have our plates pretty full at the moment and this is a nice-to-have rather than a large feature we can invest significant time in.

[mcanouil]

It does:

https://github.com/octocat/Hello-World/issues/new?title=Bug%20Report&body=Description%20here&labels=bug,help%20wanted&assignees=octocat

The issue is when using issue template, because they already populates "body" for instance.

It's not possible to fill in a template from URL currently.
Edit: it is actually, but I don't know since when.

In Quarto.org, the "report an issue" link could be replaced with the TypeScript equivalent of:

FILE=docs/authoring/markdown-basics.qmd
echo "https://github.com/quarto-dev/quarto-cli/issues/new?template=documentation.yml&title=Issue%20on%20%60${FILE}%60"

[mcanouil]

For the non-dynamic part, issue-url could be used to choose a template:
https://github.com/quarto-dev/quarto-cli/issues/new?template=documentation.yml

[mcanouil]

Source: https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue#creating-an-issue-from-a-url-query

[mcanouil]

Working example to fill some predefined fields from an issue template:

https://github.com/mcanouil/quarto-extensions/issues/new?template=submission.yml&description=my%20extension%20is%20amazing&submission=https://github.com/mcanouil/quarto-mcanouil

Note that id must be set for elements to be accessible via URL query.

[cscheid]

We need to be able to distinguish between how to build the URL for simple repositories, and for repositories that have templates; and in the template repositories, we need to be able to configure in YAML how that URL is built.

I'm happy to review PRs that do this, but it's not completely trivial.

[mcanouil]

Meanwhile, I'll make a PR to quarto-web to target the "documentation" template directly.