From 9d3bac701491f4264318b8bef42db364bbef1fa2 Mon Sep 17 00:00:00 2001 From: Paul Nothaft Date: Mon, 7 Sep 2026 23:01:26 +0200 Subject: [PATCH] docs: refresh repository support and community links --- .github/ISSUE_TEMPLATE/bug_report.md | 19 ++++++++------ .github/ISSUE_TEMPLATE/config.yml | 6 ++--- .github/ISSUE_TEMPLATE/documentation.md | 5 +++- CONTRIBUTING.md | 6 ++--- README.md | 2 +- SUPPORT.md | 33 +++++++++++++++++++++++++ 6 files changed, 55 insertions(+), 16 deletions(-) create mode 100644 SUPPORT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 6e0f33f9..8c247ebf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -24,17 +24,20 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Environment (please complete the following information):** - - OS: [e.g. Ubuntu 22.04] - - Browser: [e.g. Chrome 120, Safari 17] - - PicPeak Version: [e.g. 1.0.22] - - Deployment Method: [e.g. Docker Compose, Manual] - - Database: [e.g. PostgreSQL 15, SQLite] + - OS and version: + - Browser and version: + - PicPeak version and Docker image tag (if applicable): + - Deployment method: [Docker Compose, all-in-one container, manual] + - Database and version: [PostgreSQL, SQLite] **Logs** Please include relevant logs: ``` -# Backend logs -docker-compose logs backend | tail -50 +# Backend logs (Docker Compose) +docker compose logs --tail=50 backend + +# Or all-in-one container logs (replace picpeak if your container has another name) +docker logs --tail=50 picpeak # Frontend console errors [paste any browser console errors] @@ -44,4 +47,4 @@ docker-compose logs backend | tail -50 Add any other context about the problem here. **Possible Solution** -If you have an idea how to fix the issue, please describe it here. \ No newline at end of file +If you have an idea how to fix the issue, please describe it here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 568d1a50..070a4fd6 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ blank_issues_enabled: false contact_links: - name: πŸ“š Documentation - url: https://github.com/PicPeak/picpeak/blob/main/DEPLOYMENT.md - about: Please read the documentation before opening an issue + url: https://docs.picpeak.app + about: Installation, configuration and feature guides - name: πŸ’¬ Discussions url: https://github.com/PicPeak/picpeak/discussions about: Ask questions and discuss with the community - name: πŸ”’ Security Issues url: https://github.com/PicPeak/picpeak/blob/main/SECURITY.md - about: Please review our security policy for reporting vulnerabilities \ No newline at end of file + about: Please review our security policy for reporting vulnerabilities diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 5f39614b..017ff942 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -9,6 +9,7 @@ assignees: '' **What documentation needs improvement?** Please specify which document or section needs attention: +- [ ] Documentation website (https://docs.picpeak.app) - [ ] README.md - [ ] DEPLOYMENT.md - [ ] CONTRIBUTING.md @@ -16,6 +17,8 @@ Please specify which document or section needs attention: - [ ] Code Comments - [ ] Other: ___________ +Link to the affected page or file: + **Describe the issue** What's wrong or missing in the documentation? @@ -30,4 +33,4 @@ Who is this documentation for? - [ ] End users (photographers/clients) **Additional context** -Add any other context, examples, or references here. \ No newline at end of file +Add any other context, examples, or references here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2be69ed2..46c9d409 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,7 +59,7 @@ Unsure where to begin? You can start by looking through these issues: ### Prerequisites -- Node.js 18+ +- Node.js 22.12.0 or later (matches `backend/package.json`) - Docker & Docker Compose - Git @@ -196,6 +196,6 @@ See [RELEASING.md](RELEASING.md) for the full operational doc (promotion criteri - Create an [issue](https://github.com/PicPeak/picpeak/issues) for bugs or features - Join [discussions](https://github.com/PicPeak/picpeak/discussions) for questions -- Security issues: Open a [security issue](https://github.com/PicPeak/picpeak/issues/new?labels=security) on GitHub +- Security vulnerabilities: Follow the [security policy](SECURITY.md) and use [private vulnerability reporting](https://github.com/PicPeak/picpeak/security/advisories/new) -Thank you for contributing! πŸŽ‰ \ No newline at end of file +Thank you for contributing! πŸŽ‰ diff --git a/README.md b/README.md index 89290890..d9c05b86 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ Full documentation lives at **[docs.picpeak.app](https://docs.picpeak.app)** β€” | 🧾 CRM & Accounting | [docs.picpeak.app/features/crm](https://docs.picpeak.app/features/crm) Β· [disclaimers](https://docs.picpeak.app/features/crm/disclaimers) | | πŸ—ΊοΈ Roadmap | [GitHub Issues](https://github.com/PicPeak/picpeak/issues) | -**Project meta:** [Contributing](CONTRIBUTING.md) Β· [License](LICENSE) Β· [Security](SECURITY.md) Β· [Code of Conduct](CODE_OF_CONDUCT.md) +**Project meta:** [Support](SUPPORT.md) Β· [Contributing](CONTRIBUTING.md) Β· [License](LICENSE) Β· [Security](SECURITY.md) Β· [Code of Conduct](CODE_OF_CONDUCT.md) ## πŸ“Š Comparison with Alternatives diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..1bc9e0c6 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,33 @@ +# Getting help with PicPeak + +## Documentation + +Start with [docs.picpeak.app](https://docs.picpeak.app) for installation, +configuration, gallery features and administration guides. + +- [Getting started](https://docs.picpeak.app/getting-started) +- [Deployment](https://docs.picpeak.app/deployment) +- [Admin settings](https://docs.picpeak.app/guides/admin-settings) +- [Release channels](https://docs.picpeak.app/deployment/release-channels) + +## Questions and troubleshooting + +Use [GitHub Discussions](https://github.com/PicPeak/picpeak/discussions) for +setup questions, troubleshooting and advice from the community. Include your +PicPeak version, deployment method and what you have already tried. + +## Bugs and feature requests + +Search [existing issues](https://github.com/PicPeak/picpeak/issues) first, then +[choose an issue template](https://github.com/PicPeak/picpeak/issues/new/choose) +to report a bug, suggest a feature or identify a documentation problem. + +For bugs, include the exact version, reproduction steps and relevant logs. +See [Contributing](CONTRIBUTING.md) for development and pull request guidance. + +## Security vulnerabilities + +Follow the [security policy](SECURITY.md) and use +[private vulnerability reporting](https://github.com/PicPeak/picpeak/security/advisories/new) +or email **info@picpeak.app**. Do not report vulnerabilities in public issues +or discussions.