From 564dc70ac46930ceaf1a3d8760eade955bc5a2ab Mon Sep 17 00:00:00 2001
From: Dan Brown <ssddanbrown@googlemail.com>
Date: Mon, 11 Sep 2023 11:37:07 +0100
Subject: [PATCH] Fixed php8 compat issue, updated readme & templates
- Changed use of array spread since it was not supported in PHP8.0.
- Updated issue templates based to reduce less valueable fields, update
some details, and try to help bug reports be more focused on bugs.
- Updated readme with peertube link and attribution advistory for
translations PRs.
---
.github/ISSUE_TEMPLATE/bug_report.yml | 33 +++++++-------------
.github/ISSUE_TEMPLATE/feature_request.yml | 8 ++---
.github/ISSUE_TEMPLATE/support_request.yml | 12 ++-----
app/Activity/Controllers/WatchController.php | 5 ++-
readme.md | 2 ++
5 files changed, 22 insertions(+), 38 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 5c8734fd6..d301826c9 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,7 +1,14 @@
name: Bug Report
-description: Create a report to help us improve or fix things
+description: Create a report to help us fix bugs & issues in existing supported functionality
labels: [":bug: Bug"]
body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out a bug report!
+ Please note that this form is for reporting bugs in existing supported functionality.
+
+ If you are reporting something that's not an issue in functionality we've previously supported and/or is simply something different to your expectations, then it may be more appropriate to raise via a feature or support request instead.
- type: textarea
id: description
attributes:
@@ -13,7 +20,7 @@ body:
id: reproduction
attributes:
label: Steps to Reproduce
- description: Detail the steps that would replicate this issue
+ description: Detail the steps that would replicate this issue.
placeholder: |
1. Go to '...'
2. Click on '....'
@@ -32,7 +39,7 @@ body:
id: context
attributes:
label: Screenshots or Additional Context
- description: Provide any additional context and screenshots here to help us solve this issue
+ description: Provide any additional context and screenshots here to help us solve this issue.
validations:
required: false
- type: input
@@ -48,23 +55,7 @@ body:
id: bsversion
attributes:
label: Exact BookStack Version
- description: This can be found in the settings view of BookStack. Please provide an exact version.
- placeholder: (eg. v21.08.5)
- validations:
- required: true
- - type: input
- id: phpversion
- attributes:
- label: PHP Version
- description: Keep in mind your command-line PHP version may differ to that of your webserver. Provide that relevant to the issue.
- placeholder: (eg. 7.4)
- validations:
- required: false
- - type: textarea
- id: hosting
- attributes:
- label: Hosting Environment
- description: Describe your hosting environment as much as possible including any proxies used (If applicable).
- placeholder: (eg. Ubuntu 20.04 VPS, installed using official installation script)
+ description: This can be found in the settings view of BookStack. Please provide an exact version(s) you've tested on.
+ placeholder: (eg. v23.06.7)
validations:
required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index fb1e0b3b0..0ebb8e72f 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -33,9 +33,9 @@ body:
attributes:
label: Have you searched for an existing open/closed issue?
description: |
- To help us keep these issues under control, please ensure you have first [searched our issue list](https://github.com/BookStackApp/BookStack/issues?q=is%3Aissue) for any existing issues that cover the fundemental benefit/goal of your request.
+ To help us keep these issues under control, please ensure you have first [searched our issue list](https://github.com/BookStackApp/BookStack/issues?q=is%3Aissue) for any existing issues that cover the fundamental benefit/goal of your request.
options:
- - label: I have searched for existing issues and none cover my fundemental request
+ - label: I have searched for existing issues and none cover my fundamental request
required: true
- type: dropdown
id: existing_usage
@@ -43,8 +43,8 @@ body:
label: How long have you been using BookStack?
options:
- Not using yet, just scoping
- - 0 to 6 months
- - 6 months to 1 year
+ - Under 3 months
+ - 3 months to 1 year
- 1 to 5 years
- Over 5 years
validations:
diff --git a/.github/ISSUE_TEMPLATE/support_request.yml b/.github/ISSUE_TEMPLATE/support_request.yml
index cb2476546..4db8d1ced 100644
--- a/.github/ISSUE_TEMPLATE/support_request.yml
+++ b/.github/ISSUE_TEMPLATE/support_request.yml
@@ -33,7 +33,7 @@ body:
attributes:
label: Exact BookStack Version
description: This can be found in the settings view of BookStack. Please provide an exact version.
- placeholder: (eg. v21.08.5)
+ placeholder: (eg. v23.06.7)
validations:
required: true
- type: textarea
@@ -44,19 +44,11 @@ body:
placeholder: Be sure to remove any confidential details in your logs
validations:
required: false
- - type: input
- id: phpversion
- attributes:
- label: PHP Version
- description: Keep in mind your command-line PHP version may differ to that of your webserver. Provide that most relevant to the issue.
- placeholder: (eg. 7.4)
- validations:
- required: false
- type: textarea
id: hosting
attributes:
label: Hosting Environment
description: Describe your hosting environment as much as possible including any proxies used (If applicable).
- placeholder: (eg. Ubuntu 20.04 VPS, installed using official installation script)
+ placeholder: (eg. PHP8.1 on Ubuntu 22.04 VPS, installed using official installation script)
validations:
required: true
diff --git a/app/Activity/Controllers/WatchController.php b/app/Activity/Controllers/WatchController.php
index d63918fb3..c0b1c5872 100644
--- a/app/Activity/Controllers/WatchController.php
+++ b/app/Activity/Controllers/WatchController.php
@@ -14,10 +14,9 @@ class WatchController extends Controller
$this->checkPermission('receive-notifications');
$this->preventGuestAccess();
- $requestData = $this->validate($request, [
+ $requestData = $this->validate($request, array_merge([
'level' => ['required', 'string'],
- ...$entityHelper->validationRules()
- ]);
+ ], $entityHelper->validationRules()));
$watchable = $entityHelper->getVisibleEntityFromRequestData($requestData);
$watchOptions = new UserEntityWatchOptions(user(), $watchable);
diff --git a/readme.md b/readme.md
index 72f7d8a35..aa335f9da 100644
--- a/readme.md
+++ b/readme.md
@@ -11,6 +11,7 @@
[](https://discord.gg/ztkBqR2)
[](https://fosstodon.org/@bookstack)
[](https://twitter.com/bookstack_app)
+[](https://foss.video/c/bookstack)
[](https://www.youtube.com/bookstackapp)
A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://www.bookstackapp.com/.
@@ -81,6 +82,7 @@ Details about BookStack's versioning scheme and the general release process [can
## 🌎 Translations
Translations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables such as `:userName`. Leave these values as they are as they will be replaced at run-time. Crowdin is the preferred way to provide translations, otherwise the raw translations files can be found within the `resources/lang` path.
+Translations to original files, provided via pull request, will be fed back through Crowdin instead of being merged directly and therefore your changes & commits will not be reflected in git contribution history.
If you'd like a new language to be added to Crowdin, for you to be able to provide translations for, please [open a new issue here](https://github.com/BookStackApp/BookStack/issues/new?template=language_request.yml).