diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2c14b0d6172..6993c25af54 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -23,8 +23,10 @@ Please use the destination that matches your need so we can respond quickly. | Report a bug or unexpected behaviour. | [Bug report issue form](https://github.com/quarto-dev/quarto-cli/issues/new?template=bug_report.yml). | | Report an issue on quarto.org or suggest a documentation improvement. | [Documentation issue form](https://github.com/quarto-dev/quarto-cli/issues/new?template=documentation.yml). | | Suggest a new or missing feature. | [Feature Requests discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests). | -| Ask for help or ask a usage question. | [Q&A discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a). | +| Ask for help or ask a usage question about Quarto 1. | [Q&A (Q1) discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1). | +| Ask for help or ask a usage question about Quarto 2 (experimental). | [Q&A (Q2) discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2). | | Share what you built with Quarto. | [Show and Tell discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/show-and-tell). | +| Give feedback on the Quarto Hub preview. | [Preview (QH) discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/preview-qh). | Some issues belong to other repositories: @@ -53,8 +55,12 @@ Discussions are the right place for ideas, questions, and showcases. Before starting one, please search [existing discussions](https://github.com/quarto-dev/quarto-cli/discussions) and add to an existing thread when one already covers your topic. - [Feature Requests](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests): describe what you want to achieve and why it matters, so we can understand and prioritise it. -- [Q&A](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a): ask for help, ideally with a complete self-contained reproducible example. +- [Q&A (Q1)](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1): ask for help with Quarto 1, ideally with a complete self-contained reproducible example. +- [Q&A (Q2)](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2): ask for help with Quarto 2, ideally with a complete self-contained reproducible example. + Quarto 2 is experimental and it is not ready for production use. - [Show and Tell](https://github.com/quarto-dev/quarto-cli/discussions/categories/show-and-tell): share a project, a tip, or a use case. +- [Preview (QH)](https://github.com/quarto-dev/quarto-cli/discussions/categories/preview-qh): give feedback, ask questions, and send reports about Quarto Hub. + Quarto Hub is in preview and it is not ready for production use. ## Using AI tools to investigate diff --git a/.github/DISCUSSION_TEMPLATE/feature-requests.yml b/.github/DISCUSSION_TEMPLATE/feature-requests.yml index 6dc8b6a75b2..bffb8632740 100644 --- a/.github/DISCUSSION_TEMPLATE/feature-requests.yml +++ b/.github/DISCUSSION_TEMPLATE/feature-requests.yml @@ -12,7 +12,8 @@ body: - If you're reporting an issue with the **Visual Editor** or with the **Visual Studio Code / Positron extension**, please visit https://github.com/quarto-dev/quarto - If you're reporting an issue inside **RStudio**, please visit https://github.com/rstudio/rstudio - If you're reporting an issue inside **Positron**, please visit https://github.com/posit-dev/positron - - If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a). + - If you want to ask for help with Quarto 1, please use the [Q&A (Q1) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1). + - If you want to ask for help with Quarto 2, which is experimental and not ready for production use, please use the [Q&A (Q2) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2). First, please check [Quarto Issues](https://github.com/quarto-dev/quarto-cli/issues) and [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests) to see if your feature request has already been discussed. If it has, please consider adding a comment to the existing discussion instead of creating a new one. @@ -20,7 +21,7 @@ body: After checking, if you are not sure if your feature request has already been discussed, please create a new discussion. We look forward to hearing from you. - If you want to ask for help, please consider using the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a), as it is better suited for answering your question. + If you want to ask for help, please consider using the [Q&A (Q1)](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1) or [Q&A (Q2)](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2) GitHub Discussions, as they are better suited for answering your question. Finally, try to describe the best you can what you want to achieve and why you think it is important. This will help us to understand your request and prioritise it. diff --git a/.github/DISCUSSION_TEMPLATE/quarto-hub-preview.yml b/.github/DISCUSSION_TEMPLATE/preview-qh.yml similarity index 68% rename from .github/DISCUSSION_TEMPLATE/quarto-hub-preview.yml rename to .github/DISCUSSION_TEMPLATE/preview-qh.yml index 8faa15fdfaf..6521b3c0562 100644 --- a/.github/DISCUSSION_TEMPLATE/quarto-hub-preview.yml +++ b/.github/DISCUSSION_TEMPLATE/preview-qh.yml @@ -8,11 +8,13 @@ body: We are always happy to hear feedback from our users. This category is for feedback, questions, and reports about the **Quarto Hub preview**. (The preview is not public yet. Stay tuned, though!) + Quarto Hub is in preview and it is not ready for production use. - If you want to ask for a general Quarto feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests). - - If you want to ask for help with the `quarto` command-line program, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a). + - If you want to ask for help with Quarto 1, the `quarto` command-line program, please use the [Q&A (Q1) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1). + - If you want to ask for help with Quarto 2, the experimental `q2` command-line program, please use the [Q&A (Q2) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2). - First, please check the existing [Quarto Hub Preview discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/quarto-hub-preview) to see if your topic has already been discussed. + First, please check the existing [Preview (QH) discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/preview-qh) to see if your topic has already been discussed. If it has, please consider adding a comment to the existing discussion instead of creating a new one. Finally, try to describe the best you can what you are trying to do, what you expected, and what happened instead. diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a-q1.yml similarity index 87% rename from .github/DISCUSSION_TEMPLATE/q-a.yml rename to .github/DISCUSSION_TEMPLATE/q-a-q1.yml index 2fe44763f60..b4c5250a8d2 100644 --- a/.github/DISCUSSION_TEMPLATE/q-a.yml +++ b/.github/DISCUSSION_TEMPLATE/q-a-q1.yml @@ -6,14 +6,15 @@ body: Welcome to the Quarto CLI GitHub repository! We are always happy to hear feedback from our users. - This is the repository for the command-line program `quarto`: + This category is for questions about **Quarto 1**, version 1 of the `quarto` command-line program: + - If your question is about **Quarto 2**, version 2 of Quarto, which is experimental and not ready for production use, please use the [Q&A (Q2) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2). - If you're reporting an issue with the **Visual Editor** or with the **Visual Studio Code / Positron extension**, please visit https://github.com/quarto-dev/quarto - If you're reporting an issue inside **RStudio**, please visit https://github.com/rstudio/rstudio - If you're reporting an issue inside **Positron**, please visit https://github.com/posit-dev/positron - If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests). - First, please check [Quarto Issues](https://github.com/quarto-dev/quarto-cli/issues) and [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a) to see if your question has already been asked. + First, please check [Quarto Issues](https://github.com/quarto-dev/quarto-cli/issues) and [Q&A (Q1) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1) to see if your question has already been asked. If it has, please consider adding a comment to the existing discussion instead of creating a new one. After checking, if you are not sure if your question has already been asked, please create a new discussion. diff --git a/.github/DISCUSSION_TEMPLATE/q-a-q2.yml b/.github/DISCUSSION_TEMPLATE/q-a-q2.yml new file mode 100644 index 00000000000..ff9fbf8d296 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-a-q2.yml @@ -0,0 +1,89 @@ +title: "Your question in one sentence (e.g., How do I render a document with Quarto 2?)" +labels: ["q2"] +body: + - type: markdown + attributes: + value: | + Welcome to the Quarto 2 discussions! + We are always happy to hear feedback from our users. + + This category is for questions about **Quarto 2**, version 2 of Quarto. + Quarto 2 is experimental and it is not ready for production use. + Its source code is at https://github.com/quarto-dev/q2 and its command-line program is `q2`. + + - If your question is about **Quarto 1**, version 1 of the `quarto` command-line program, please use the [Q&A (Q1) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1). + - If you're reporting a bug in **Quarto 2**, please open an issue at https://github.com/quarto-dev/q2/issues + - If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests). + + First, please check [Quarto 2 Issues](https://github.com/quarto-dev/q2/issues) and [Q&A (Q2) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2) to see if your question has already been asked. + If it has, please consider adding a comment to the existing discussion instead of creating a new one. + + After checking, if you are not sure if your question has already been asked, please create a new discussion. + We look forward to hearing from you. + + 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 + --- + + This is a reproducible Quarto document using `format: html`. + + ![An image](image.png){#fig-placeholder} + + A reference to @fig-placeholder. + + The end. + ```` + ````` + + You can add some additional information that can help us to help you: + + - What Quarto 2 version are you using? + You can find the version of Quarto 2 you used by running `q2 --version` in your terminal. + - What operating system are you using? + Linux Ubuntu 24.04, macOS 15.2, Windows 11, _etc._ + + _Thank you for opening this discussion either to ask for help or to report a possible bug!_ + - type: textarea + attributes: + label: Description + description: Start your question/report! + placeholder: | + You can include Quarto document code which includes code blocks like this: + + `````md + ````qmd + --- + title: "Reproducible Quarto Document" + format: html + --- + + This is a reproducible Quarto document using `format: html`. + + ![An image](image.png){#fig-placeholder} + + A reference to @fig-placeholder. + + The end. + ```` + ````` + + --- + + ### Additional information that can help us to help you + + - What Quarto 2 version are you using? + You can find the version of Quarto 2 you used by running `q2 --version` in your terminal. + - What operating system are you using? + Linux Ubuntu 24.04, macOS 15.2, Windows 11, _etc._ + validations: + required: true + - type: markdown + attributes: + value: | + _Thank you for opening this discussion either to ask for help or to report a possible bug!_ diff --git a/.github/DISCUSSION_TEMPLATE/show-and-tell.yml b/.github/DISCUSSION_TEMPLATE/show-and-tell.yml index 99b091b143b..a5668ba785e 100644 --- a/.github/DISCUSSION_TEMPLATE/show-and-tell.yml +++ b/.github/DISCUSSION_TEMPLATE/show-and-tell.yml @@ -4,7 +4,8 @@ body: attributes: value: | If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests). - If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a). + If you want to ask for help with Quarto 1, please use the [Q&A (Q1) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1). + If you want to ask for help with Quarto 2, which is experimental and not ready for production use, please use the [Q&A (Q2) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2). - type: textarea attributes: label: Description diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3e828f92edb..bfbe8dea58d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -15,7 +15,8 @@ body: - If you're reporting an issue inside **RStudio**, please visit https://github.com/rstudio/rstudio - If you're reporting an issue inside **Positron**, please visit https://github.com/posit-dev/positron/discussions - If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests). - - If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a). + - If you want to ask for help with Quarto 1, please use the [Q&A (Q1) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1). + - If you want to ask for help with Quarto 2, which is experimental and not ready for production use, please use the [Q&A (Q2) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2). Quarto is under active development! If convenient, we'd appreciate if you could check that the issue persists on the [latest pre-release](https://github.com/quarto-dev/quarto-cli/releases). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d84501fef0f..b4272141d72 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,9 +3,12 @@ contact_links: - name: Issue guide url: https://quarto.org/bug-reports.html about: First time here or need a refresh? Please consult the issue guide before posting. - - name: Ask a question - url: https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a - about: Please ask and answer questions in our Discussion board + - name: Ask a question about Quarto 1 + url: https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1 + about: Please ask and answer questions about Quarto 1 in our Discussion board + - name: Ask a question about Quarto 2 + url: https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2 + about: Quarto 2 is experimental and not ready for production use. Please ask and answer questions about it in our Discussion board - name: Share an idea, a missing feature or anything else url: https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests about: Please give us any feedback in our Discussion board diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index cf279260066..bfdaad47c71 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -13,7 +13,8 @@ body: If you want to report a bug, please use the [Bug Reports GitHub Issues](https://github.com/quarto-dev/quarto-cli/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml). If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests). - If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a). + If you want to ask for help with Quarto 1, please use the [Q&A (Q1) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q1). + If you want to ask for help with Quarto 2, which is experimental and not ready for production use, please use the [Q&A (Q2) GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a-q2). Thank you for using Quarto!