Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved Permissions Error Messages for Initial Install #2435

Merged
merged 2 commits into from
Nov 7, 2020
Merged

Improved Permissions Error Messages for Initial Install #2435

merged 2 commits into from
Nov 7, 2020

Conversation

nina-py
Copy link
Contributor

@nina-py nina-py commented Nov 3, 2020

  • Made the wording of the error more generic
  • Added link to the relevant section in the installation guide

Fixes #2327

Changes proposed in this pull request:

The "Hold up!" page during the installation process.

Reviewers should focus on:

The wording of the message.

Screenshot
flarum-updated-permissions-error-message

Confirmed

  • Frontend changes: tested on a local Flarum installation.
  • Backend changes: tests are green (run composer test).

Required changes:

- Made the wording of the error more generic
- Added link to the relevant section in the installation guide

Resolves #2327.
@nina-py
Copy link
Contributor Author

nina-py commented Nov 5, 2020

@askvortsov1, thanks for merging the related pull request with the update to the installation docs. This one makes the error message more generic and adds a link to the docs, could you please review?

@@ -53,7 +53,7 @@ private function getNonWritablePaths(): Collection
})->map(function ($path, $index) {
return [
'message' => 'The '.$this->getAbsolutePath($path).' directory is not writable.',
'detail' => 'Please chmod this directory'.(in_array($index, $this->wildcards) ? ' and its contents' : '').' to 0775.'
'detail' => 'Please make sure your web server/PHP user has write access to this directory'.(in_array($index, $this->wildcards) ? ' and its contents' : '').'. Please read the <a href="https://docs.flarum.org/install.html#folder-ownership">installation documentation</a> for a detailed explanation and steps to follow to resolve this error.'
Copy link
Sponsor Member

@askvortsov1 askvortsov1 Nov 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor wording critiques:

  • Both sentences start with please, that's a bit much imo, we can probably remove that from the second sentence.
  • "steps to follow to resolve this error" => "steps to resolve this error"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated with both changes - looks better now.

@askvortsov1 askvortsov1 merged commit c10cc92 into flarum:master Nov 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Permissions Error Messages for Initial Install
3 participants