feedback on install guide

Open
#86 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
laravel, php
Domain
documentation

Research direction

Start with the install guide referenced by this issue and identify the sections covering components, permissions, and the PHP artisan commands. Update the explanations, restrict the documented permissions to the stated directories, and document artisan install as an alternative flow. Done means all three checklist items are addressed in the guide.

Written by the indexing model from the issue text.

Description

https://cathode.church/@meena/108064445721565119

there's too many components and i don't understand what they do

  • explain what each component does

i would never give an application server write access to the entire application its serving. i'd give it granular access to a few directories it needs.

  • remove the step where we set permissions to 775/664 -- or at least make it only applicable to the storage/ and bootstrap/ directories

there's about a dozen php artisan calls that need to be done

  • add artisan install as an alternatively supported installation flow
Dominant language
JavaScript
Stars
186
Forks
78
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pixelfed/docs

All issues in pixelfed/docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.