diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index dc2e0384..69fab4ca 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -14,13 +14,12 @@ body: - type: textarea id: description attributes: - label: Describe the bug + label: Provide a screenshot and describe the bug description: | - A description of what the issue is, what you expected to happen, and if relevant, the *URLs you were trying to archive* (if relevant). + Attach a screenshot and describe what the issue is, what you expected to happen, and if relevant, the *URLs you were trying to archive*. placeholder: | - Got a bunch of 'singlefile was unable to archive this page' errors when trying to archive URLs from this site: - https://example.com/xyz ... - I also tried to archive the same URLs using `singlefile` directly and some of them worked but not all of them. + Got a bunch of 'singlefile was unable to archive this page' errors when trying to archive URLs from this site: https://example.com/xyz ... + I also tried to archive the same URLs using `singlefile` directly and some of them worked but not all of them. etc. ... validations: required: true @@ -29,6 +28,7 @@ body: attributes: label: Steps to reproduce description: Please include the exact steps you took to trigger the issue. + render: markdown placeholder: | 1. Started ArchiveBox by running: `docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox:latest` 2. Went to the https://127.0.0.1:8000/add/ page in Google Chrome @@ -41,19 +41,27 @@ body: - type: textarea id: logs attributes: - label: Screenshots or log output - description: "Please **paste a screenshot of the issue** and/or any terminal output or logs (check `data/logs/errors.log` as well)." - placeholder: + label: Logs or errors + description: "Paste any terminal output, logs, or errors (check `data/logs/errors.log` as well)." + placeholder: | + ╭─────────────────────────────────────────────────────────────────────────────────────────────────────────╮ + │ [2024-11-02 19:54:28] ArchiveBox v0.8.6rc0: archivebox add https://example.com#1234567 │ + ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + [+] [2024-11-02 19:54:29] Adding 1 links to index (crawl depth=0)... + > Saved verbatim input to sources/1730577269-import.txt + > Parsed 1 URLs from input (Generic TXT) + ... render: shell validations: - required: true + required: false - type: textarea id: version attributes: label: ArchiveBox Version description: | - Run the `archivebox version` command inside your collection folder and paste the *full* output here (*NOT JUST THE VERSION NUMBER*). + **REQUIRED:** Run the `archivebox version` command inside your collection dir and paste the *full output* here (*not just the version number*). For Docker Compose run: `docker compose run archivebox version` For plain Docker run: `docker run -v $PWD:/data archivebox/archivebox version` render: shell @@ -122,8 +130,8 @@ body: - type: textarea id: docker_compose_yml attributes: - label: Docker Compose file - description: "If using Docker Compose, please share your full `docker-compose.yml` file (or the `docker run ...` command you use)." + label: Docker Compose Configuration + description: "If using Docker Compose, please share your full `docker-compose.yml` file. If using plain Docker, paste the `docker run ...` command you use." placeholder: | services: archivebox: @@ -177,13 +185,13 @@ body: --- We strive to answer issues as quickly as possible, it usually takes us *about a ~week* to respond. - Make sure your archive `data/` is [**fully backed up**](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#disk-layout) before trying anything suggested here, **we are not responsible for data loss**. + Make sure your `data/` is [**fully backed up**](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#disk-layout) before trying anything suggested here, **we are not responsible for data loss**. In the meantime please consider: - - [💰 Donating](https://github.com/ArchiveBox/ArchiveBox/wiki/Donations) to support ArchiveBox open-source - - [👨‍✈️ Hiring us](https://docs.monadical.com/s/archivebox-consulting-services) for corporate deployments with professional support, custom feature development, help with CAPTCHAs/rate-limits. - - [🔍 Searching the docs](https://docs.archivebox.io/) for answers to common questions + - 💰 [Donating to support ArchiveBox open-source](https://github.com/ArchiveBox/ArchiveBox/wiki/Donations) + - 👨‍✈️ [Hiring us for corporate deployments](https://docs.monadical.com/s/archivebox-consulting-services) with professional support, custom feature development, and help with CAPTCHAs/rate-limits + - 🔍 [Searching the Documentation](https://docs.archivebox.io/) for answers to common questions - 📚 Reading the [Troubleshooting Guide](https://github.com/ArchiveBox/ArchiveBox/wiki) - - ✨ Trying a newer [`BETA` release](https://github.com/ArchiveBox/ArchiveBox/releases) (issues are often already fixed in our latest `BETA` releases) + - ✨ Testing out a newer [`BETA` release](https://github.com/ArchiveBox/ArchiveBox/releases) (issues are often already fixed in our latest `BETA` releases)