docs: refresh repository support and community links (#1349)
Co-authored-by: Paul Nothaft <[email protected]>
This commit is contained in:
co-authored by
Paul Nothaft
parent
d36585379f
commit
f83cbe9109
@@ -24,17 +24,20 @@ A clear and concise description of what you expected to happen.
|
|||||||
If applicable, add screenshots to help explain your problem.
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
**Environment (please complete the following information):**
|
**Environment (please complete the following information):**
|
||||||
- OS: [e.g. Ubuntu 22.04]
|
- OS and version:
|
||||||
- Browser: [e.g. Chrome 120, Safari 17]
|
- Browser and version:
|
||||||
- PicPeak Version: [e.g. 1.0.22]
|
- PicPeak version and Docker image tag (if applicable):
|
||||||
- Deployment Method: [e.g. Docker Compose, Manual]
|
- Deployment method: [Docker Compose, all-in-one container, manual]
|
||||||
- Database: [e.g. PostgreSQL 15, SQLite]
|
- Database and version: [PostgreSQL, SQLite]
|
||||||
|
|
||||||
**Logs**
|
**Logs**
|
||||||
Please include relevant logs:
|
Please include relevant logs:
|
||||||
```
|
```
|
||||||
# Backend logs
|
# Backend logs (Docker Compose)
|
||||||
docker-compose logs backend | tail -50
|
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
|
# Frontend console errors
|
||||||
[paste any browser console errors]
|
[paste any browser console errors]
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: 📚 Documentation
|
- name: 📚 Documentation
|
||||||
url: https://github.com/PicPeak/picpeak/blob/main/DEPLOYMENT.md
|
url: https://docs.picpeak.app
|
||||||
about: Please read the documentation before opening an issue
|
about: Installation, configuration and feature guides
|
||||||
- name: 💬 Discussions
|
- name: 💬 Discussions
|
||||||
url: https://github.com/PicPeak/picpeak/discussions
|
url: https://github.com/PicPeak/picpeak/discussions
|
||||||
about: Ask questions and discuss with the community
|
about: Ask questions and discuss with the community
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ assignees: ''
|
|||||||
|
|
||||||
**What documentation needs improvement?**
|
**What documentation needs improvement?**
|
||||||
Please specify which document or section needs attention:
|
Please specify which document or section needs attention:
|
||||||
|
- [ ] Documentation website (https://docs.picpeak.app)
|
||||||
- [ ] README.md
|
- [ ] README.md
|
||||||
- [ ] DEPLOYMENT.md
|
- [ ] DEPLOYMENT.md
|
||||||
- [ ] CONTRIBUTING.md
|
- [ ] CONTRIBUTING.md
|
||||||
@@ -16,6 +17,8 @@ Please specify which document or section needs attention:
|
|||||||
- [ ] Code Comments
|
- [ ] Code Comments
|
||||||
- [ ] Other: ___________
|
- [ ] Other: ___________
|
||||||
|
|
||||||
|
Link to the affected page or file:
|
||||||
|
|
||||||
**Describe the issue**
|
**Describe the issue**
|
||||||
What's wrong or missing in the documentation?
|
What's wrong or missing in the documentation?
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -59,7 +59,7 @@ Unsure where to begin? You can start by looking through these issues:
|
|||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Node.js 18+
|
- Node.js 22.12.0 or later (matches `backend/package.json`)
|
||||||
- Docker & Docker Compose
|
- Docker & Docker Compose
|
||||||
- Git
|
- 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
|
- Create an [issue](https://github.com/PicPeak/picpeak/issues) for bugs or features
|
||||||
- Join [discussions](https://github.com/PicPeak/picpeak/discussions) for questions
|
- 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! 🎉
|
Thank you for contributing! 🎉
|
||||||
@@ -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) |
|
| 🧾 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) |
|
| 🗺️ 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
|
## 📊 Comparison with Alternatives
|
||||||
|
|
||||||
|
|||||||
+33
@@ -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 **[email protected]**. Do not report vulnerabilities in public issues
|
||||||
|
or discussions.
|
||||||
Reference in New Issue
Block a user