itsgoingd / itsgoingd/clockwork

Possible update to the documentation re: require-dev

Open
#572 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
6k
Forks
333
Avg merge
5m
Merged PRs (30d)
1

Description

Re: https://underground.works/clockwork/#docs-installation

Since this is primarily a development only tool and shouldn't be on production, is there any specific reason why the documentation does not show the default install command for require-dev?

composer require --dev itsgoingd/clockwork

Personally I like the better safe than sorry approach. Sometimes a miscommunication with DevOps might have them set the .env variable as true, which can expose a production env. This actually happened with one of ours sites. Luckily I caught it soon enough, but that could have caused major problems if I didn't.

Another thing I noticed, is that for the same site, the APP_DEBUG was set as false, but CLOCKWORK_ENABLE was set as true. So in this case, setting debug to false was ignored. Perhaps it could be more clearly obvious in the documentation on this page that CLOCKWORK_ENABLE has priority over APP_DEBUG.

https://underground.works/clockwork/#docs-collected-data

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.

Research direction

Review the Installation and Collected Data sections at the linked Clockwork documentation page. Update the installation guidance to show the Composer require-dev command and make the precedence of CLOCKWORK_ENABLE over APP_DEBUG clear; the documentation should explicitly cover both points.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.