Create recipes page on deployer.org about recipes

[gordalina]

sounds good, do you have anything in mind to accomplish this?

[antonmedv]

I think there is must be route:

$app->get('/recipes', function () {
    // TODO render  page
});

Which will be parse GitHub repositories (deployphp/recipe/, deployphp/deployer/recipes/) for *.php files with GitHub API. And parse PHP code of recipe, collecting data (task names, env vars, params) and DocBlock. And generate one page with all recipes on it.

Recipe: Symfony

Tasks

...

Parameters

...

Recipe: Laravel

Tasks

...

Parameters

...

[johnny-bit]

The recipes themselves have docs as required by Contributing section in readme. Why not instead of parsing php file, get markdown doc for each recipe and render it using something like Parsedown?

[ZeeCoder]

If you look at the docs repo, this is exactly what the site does.
Now I think the idea here is that now the "API" of the recipes would be available on the site, which would be generated dynamically.

I think @Elfet means to keep the existing recipe documentation, since there could be a lot to explain about a recipe's usage / best practices, but it would be great to have an automatically-generated documentation from DocBlock comments, like this: http://api.symfony.com/2.0/Symfony/Component/Translation/Translator.html

[johnny-bit]

Ah, I see :)

2015-06-11 11:10 GMT+02:00 Hubert Viktor [email protected]:

If you look at the docs https://github.com/deployphp/docs repo, this is
exactly what the site does.
Now I think the idea here is that now the "API" of the recipes would be
available on the site, which would be generated dynamically.

I think @Elfet https://github.com/elfet means to keep the existing
recipe documentation, since there could be a lot to explain about a
recipe's usage / best practices, but it would be great to have an
automatically-generated documentation from DocBlock comments, like this:
http://api.symfony.com/2.0/Symfony/Component/Translation/Translator.html

—
Reply to this email directly or view it on GitHub
#8 (comment).

Pozdrawiam,
Hubert Kowalski

[antonmedv]

Yeah, we need some place to collect all recipes...

...and rule them all!

[antonmedv]

I try to do it myself right now +)

[gordalina]

that would be awesome 😄 🍻

[antonmedv]

DONE! http://deployer.org/recipes

[ZeeCoder]

Nice 👍
Although there's quite a few 404 errors in the Recipes table. ><

[gordalina]

good job @Elfet

[antonmedv]

@gordalina can you rewrite README to relative links? (Like in docs)

[gordalina]

done on 968b283