rocketeers / docs Goto Github PK

Hi

This documentation does not have any learning curve.

For me it is very hard to understand the documentation.
Using the console, it was quite easy to get to the first deploy, but without that it is a nightmare.
To do some next level things eg.: multiple staging, using hooks is mindfuck.
I put echo "asd"; in my hooks.php. And it does not fire at all. Doc does not say how to do it.

Please change the font color! My eyes are exploding.
Ergonomics please! font color #808d8e, background color #edf1f2 WHY?

PS: I dont want to be rude. Lot of us, I think struggling with the configuration, whoever it is very easy and well engineered.

If one use this:
https://github.com/rocketeers/docs/blame/master/II-Concepts/Tasks.md#L83

one will get a PHP Fatal error: Class 'Rocketeer\Tasks\Rocketeer' not found in .rocketeer/tasks.php on line 5

https://github.com/rocketeers/docs/blame/master/II-Concepts/Tasks.md#L136

Which config file? config.php or hooks.php?
I think in the hooks.php like this:

'custom' => [
    'db:migrate' => 'MyTask\Migrate'
],

and not the way as in the docs.

@acmitch commented on Thu Aug 06 2015

So I've created a custom task, however, when trying to call $this->getOption('start_date'); I get the error

  [RuntimeException]
  The "--start_date" option does not exist

deploy:custom [-P|--parallel] [-p|--pretend] [-C|--on="..."] [-S|--stage="..."] [-B|--branch="..."] [--host="..."] [--username="..."] [--password="..."] [--key="..."] [--keyphrase="..."] [--agent="..."] [--repository="..."]

Looking at the migration tasks and others. It seems custom options can be passed through?

@acmitch commented on Tue Aug 11 2015

Wanted to follow up for anyone having similar issues. This is very possible.

All you have to do is create a custom command which extends BaseTaskCommand and override the getOptions child function.

To get your newly created command class to autoload, simply place your code in one of the autoloaded folders such as 'strategies' or 'tasks'.

I know this comment is very broad, so check out how Anahkiasen handles extending the 'deploy' command here.

You can see he has a class doing what I just described above. @Anahkiasen you really need some documenation on this. I love this library but to use it as a task runner the ability to have rocketeer as an extension of my libraries is really helpful.

For the short term just simply autoloading a 'commands' directory if it exists would be great!

@Anahkiasen commented on Tue Aug 11 2015

As you may have noticed I'm rather buys currently so Rocketeer is a bit in pause, but all PRs are welcome to the rocketeer/docs repo

The first sample on this page isn't valid PHP code. Looks like half an array? Pretty confusing.