From f0470afb4c0ba1176625cf7a8c8be52f0ef4ec74 Mon Sep 17 00:00:00 2001 From: Dan Brown <ssddanbrown@googlemail.com> Date: Sun, 13 Feb 2022 13:16:43 +0000 Subject: [PATCH] Applied StyleCI changes, updated readme badges & roadmap --- app/Auth/Queries/AllUsersPaginatedAndSorted.php | 5 +---- app/Auth/Queries/UserContentCounts.php | 2 +- app/Auth/Queries/UserRecentlyCreatedContent.php | 2 +- app/Entities/Tools/ExportFormatter.php | 2 +- app/Http/Controllers/UserController.php | 4 ++-- readme.md | 12 ++++++++---- 6 files changed, 14 insertions(+), 13 deletions(-) diff --git a/app/Auth/Queries/AllUsersPaginatedAndSorted.php b/app/Auth/Queries/AllUsersPaginatedAndSorted.php index 664db1925..7b849eaf4 100644 --- a/app/Auth/Queries/AllUsersPaginatedAndSorted.php +++ b/app/Auth/Queries/AllUsersPaginatedAndSorted.php @@ -2,7 +2,6 @@ namespace BookStack\Auth\Queries; - use BookStack\Auth\User; use Illuminate\Pagination\LengthAwarePaginator; @@ -14,7 +13,6 @@ use Illuminate\Pagination\LengthAwarePaginator; */ class AllUsersPaginatedAndSorted { - /** * @param array{sort: string, order: string, search: string} $sortData */ @@ -38,5 +36,4 @@ class AllUsersPaginatedAndSorted return $query->paginate($count); } - -} \ No newline at end of file +} diff --git a/app/Auth/Queries/UserContentCounts.php b/app/Auth/Queries/UserContentCounts.php index b8d99be14..397719383 100644 --- a/app/Auth/Queries/UserContentCounts.php +++ b/app/Auth/Queries/UserContentCounts.php @@ -27,4 +27,4 @@ class UserContentCounts 'shelves' => Bookshelf::visible()->where($createdBy)->count(), ]; } -} \ No newline at end of file +} diff --git a/app/Auth/Queries/UserRecentlyCreatedContent.php b/app/Auth/Queries/UserRecentlyCreatedContent.php index 31dd9de68..5060227c0 100644 --- a/app/Auth/Queries/UserRecentlyCreatedContent.php +++ b/app/Auth/Queries/UserRecentlyCreatedContent.php @@ -34,4 +34,4 @@ class UserRecentlyCreatedContent 'shelves' => $query(Bookshelf::visible()), ]; } -} \ No newline at end of file +} diff --git a/app/Entities/Tools/ExportFormatter.php b/app/Entities/Tools/ExportFormatter.php index 5617db692..7edd1b50f 100644 --- a/app/Entities/Tools/ExportFormatter.php +++ b/app/Entities/Tools/ExportFormatter.php @@ -153,7 +153,7 @@ class ExportFormatter } /** - * Within the given HTML content, Open any detail blocks + * Within the given HTML content, Open any detail blocks. */ protected function openDetailElements(string $html): string { diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php index a22b0394a..2c9203687 100644 --- a/app/Http/Controllers/UserController.php +++ b/app/Http/Controllers/UserController.php @@ -48,8 +48,8 @@ class UserController extends Controller $users->appends($listDetails); return view('users.index', [ - 'users' => $users, - 'listDetails' => $listDetails + 'users' => $users, + 'listDetails' => $listDetails, ]); } diff --git a/readme.md b/readme.md index 7829026ad..6bc34256a 100644 --- a/readme.md +++ b/readme.md @@ -3,10 +3,14 @@ [![GitHub release](https://img.shields.io/github/release/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/releases/latest) [![license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/BookStackApp/BookStack/blob/development/LICENSE) [![Crowdin](https://badges.crowdin.net/bookstack/localized.svg)](https://crowdin.com/project/bookstack) -[![Discord](https://img.shields.io/static/v1?label=chat&message=discord&color=738adb&logo=discord)](https://discord.gg/ztkBqR2) -[![Repo Stats](https://img.shields.io/static/v1?label=GitHub+project&message=stats&color=f27e3f)](https://gh-stats.bookstackapp.com/) [![Build Status](https://github.com/BookStackApp/BookStack/workflows/phpunit/badge.svg)](https://github.com/BookStackApp/BookStack/actions) [![StyleCI](https://github.styleci.io/repos/41589337/shield?style=flat)](https://github.styleci.io/repos/41589337) +[![Maintainability](https://api.codeclimate.com/v1/badges/5551731994dd22fa1f4f/maintainability)](https://codeclimate.com/github/BookStackApp/BookStack/maintainability) + +[![Repo Stats](https://img.shields.io/static/v1?label=GitHub+project&message=stats&color=f27e3f)](https://gh-stats.bookstackapp.com/) +[![Discord](https://img.shields.io/static/v1?label=Discord&message=chat&color=738adb&logo=discord)](https://discord.gg/ztkBqR2) +[![Twitter](https://img.shields.io/static/v1?label=Twitter&message=@bookstack_app&color=1d9bf0&logo=twitter)](https://twitter.com/bookstack_app) +[![YouTube](https://img.shields.io/static/v1?label=YouTube&message=bookstackapp&color=ff0000&logo=youtube)](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/. @@ -57,9 +61,9 @@ Note: Listed services are not tested, vetted nor supported by the official BookS Below is a high-level road map view for BookStack to provide a sense of direction of where the project is going. This can change at any point and does not reflect many features and improvements that will also be included as part of the journey along this road map. For more granular detail of what will be included in upcoming releases you can review the project milestones as defined in the "Release Process" section below. -- **Platform REST API** *(Base Implemented, In review and roll-out)* +- **Platform REST API** - *(Most actions implemented, maturing)* - *A REST API covering, at minimum, control of core content models (Books, Chapters, Pages) for automation and platform extension.* -- **Editor Alignment & Review** +- **Editor Alignment & Review** - *(Started)* - *Review the page editors with goal of achieving increased interoperability & feature parity while also considering collaborative editing potential.* - **Permission System Review** - *Improvement in how permissions are applied and a review of the efficiency of the permission & roles system.*