From 808fc9d6cb199a9e659bba32fb015640721f80b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20Canouil?= <8896044+mcanouil@users.noreply.github.com> Date: Thu, 20 Jun 2024 22:05:18 +0200 Subject: [PATCH 1/3] docs: improve reprex in issue/discussion templates --- .github/DISCUSSION_TEMPLATE/q-a.yml | 27 ++++++++++++--- .github/ISSUE_TEMPLATE/bug_report.yml | 50 ++++++++++++++++++++++++--- 2 files changed, 68 insertions(+), 9 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml index d384951caef..da911624dd4 100644 --- a/.github/DISCUSSION_TEMPLATE/q-a.yml +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -28,7 +28,11 @@ body: print("Hello, world!") ``` - ![A placeholder image](https://placehold.co/600x400.png) + ![An image]({{< placeholder 600 400 >}}){#fig-placeholder} + + {{< lipsum 1 >}} + + A reference to @fig-placeholder. The end. ```` @@ -49,16 +53,31 @@ body: placeholder: | You can include Quarto document code which includes code blocks like this: + `````md ````qmd --- - title: "Hello Quarto!" + title: "Reproducible Quarto Document" format: html + engine: jupyter --- - ```py - print("Hello Quarto!") + This is a reproducible Quarto document using `format: html`. + It is written in Markdown and contains embedded Python code. + When you run the code, it will produce a message. + + ```{python} + print("Hello, world!") ``` + + ![An image]({{< placeholder 600 400 >}}){#fig-placeholder} + + {{< lipsum 1 >}} + + A reference to @fig-placeholder. + + The end. ```` + ````` --- diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f4032cd455d..b6a23ac426e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,7 +10,7 @@ body: We are always happy to hear feedback from our users. This is the repository for the command-line program `quarto`: - + - If you're reporting an issue with the VS Code extension, please visit https://github.com/quarto-dev/quarto - If you're reporting an issue inside RStudio, please visit https://github.com/rstudio/rstudio @@ -24,6 +24,37 @@ body: Thank you for using Quarto! + --- + + Finally, try to describe the best you can what you want to achieve or what is your issue, especially by providing a complete self-contained reproducible example (consider reading our ["Bug Reports" guide](https://quarto.org/bug-reports.html)). + This will help us to understand your question and answer it. + + `````md + ````qmd + --- + title: "Reproducible Quarto Document" + format: html + engine: jupyter + --- + + This is a reproducible Quarto document using `format: html`. + It is written in Markdown and contains embedded Python code. + When you run the code, it will produce a message. + + ```{python} + print("Hello, world!") + ``` + + ![An image]({{< placeholder 600 400 >}}){#fig-placeholder} + + {{< lipsum 1 >}} + + A reference to @fig-placeholder. + + The end. + ```` + ````` + - type: textarea attributes: label: Bug description @@ -39,22 +70,31 @@ body: placeholder: | You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `). + `````md ````qmd --- title: "Reproducible Quarto Document" format: html + engine: jupyter --- This is a reproducible Quarto document using `format: html`. - It is written in Markdown and contains embedded R code. - When you run the code, it will produce a plot. + It is written in Markdown and contains embedded Python code. + When you run the code, it will produce a message. - ```{r} - plot(cars) + ```{python} + print("Hello, world!") ``` + ![An image]({{< placeholder 600 400 >}}){#fig-placeholder} + + {{< lipsum 1 >}} + + A reference to @fig-placeholder. + The end. ```` + ````` - type: textarea attributes: From 0f268a087b5dec8fe7e7e7ec4509e280d8d6457e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20Canouil?= <8896044+mcanouil@users.noreply.github.com> Date: Thu, 20 Jun 2024 22:09:06 +0200 Subject: [PATCH 2/3] docs: change reprex intro sentence --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b6a23ac426e..bd01ada33dc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -26,8 +26,7 @@ body: --- - Finally, try to describe the best you can what you want to achieve or what is your issue, especially by providing a complete self-contained reproducible example (consider reading our ["Bug Reports" guide](https://quarto.org/bug-reports.html)). - This will help us to understand your question and answer it. + You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `). `````md ````qmd From dc3bfcbbea4cf5e6b8248b497e814ecec28934b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20Canouil?= <8896044+mcanouil@users.noreply.github.com> Date: Thu, 20 Jun 2024 22:19:04 +0200 Subject: [PATCH 3/3] docs: add version --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index bd01ada33dc..cccaad7d6a6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -27,6 +27,7 @@ body: --- You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `). + For example with Quarto CLI >=1.5: `````md ````qmd