From 6b8ab2604d3c5950f18007b0a165f7622ed82345 Mon Sep 17 00:00:00 2001 From: gerMdz Date: Fri, 10 Dec 2021 23:58:12 +0000 Subject: [PATCH] GitBook: [#1] dando el primer pantallazo de AlamedaCMS --- README.md | 105 +++++++----------- SUMMARY.md | 10 +- {guides => guias}/advanced-permissions.md | 0 .../creating-your-first-project.md | 0 {guides => guias}/creating-your-first-task.md | 0 5 files changed, 45 insertions(+), 70 deletions(-) rename {guides => guias}/advanced-permissions.md (100%) rename {guides => guias}/creating-your-first-project.md (100%) rename {guides => guias}/creating-your-first-task.md (100%) diff --git a/README.md b/README.md index 50283f6c..a1ededc1 100755 --- a/README.md +++ b/README.md @@ -1,46 +1,41 @@ +# ¿Qué es AlamedaCMS? -# What is MyProduct? +> AlamedaCMS es un sistema de gestión, un entorno de trabajo para la creación y administración, de contenidos web. +> +> Principalmente indicado para entornos con acceso ssh y pleno control del server (ej. VPS). +> +> Basado en [Symfony](https://symfony.com), un [framework](https://symfony.com) líder en PHP, y por tanto en estándares modernos, donde pueda tener pleno control del código, siendo fácil de actualizar, fácil de mantener, con un árbol de directorios claro. -{% hint style="info" %} -**Good to know:** providing a brief overview of your product and its core use cases is a great place to start with product docs. Your product might seem obvious to you – you made it! However, to others, even folks who are trying your product after reading your site or getting a sales demo, it can still be unclear. This is your chance to clarify your product and set the right expectations! -{% endhint %} +> Incluye el módulo de reservas ([payunpile](https://github.com/gerMdz/payunpile)) y de enlaces ([incalinks](https://germdz.github.io/incalinks/)) -Here are a couple of examples of succinct overviews from products with really great docs: +## Empezando -> Loom is a video messaging tool that helps you get your message across through instantly shareable videos. -> -> With Loom, you can record your camera, microphone, and desktop simultaneously. Your video is then instantly available to share through Loom's patented technology. -> -> — From the [Loom Docs](https://support.loom.com/hc/en-us/articles/360002158057-What-is-Loom-) +Para usar AlamedaCMS debes bajarlo de [github](https://github.com/gerMdz/AlamedaCMS.git), y luego bajar sus dependencias de paquetes. -> The Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more. -> -> — From the [Mailchimp Marketing API docs](https://mailchimp.com/developer/marketing/docs/fundamentals/) +git clone https://github.com/gerMdz/AlamedaCMS.git -## Getting Started +cd project -**Got 2 minutes?** Check out a video overview of our product: +composer install -{% embed url="https://www.loom.com/share/3bfa83acc9fd41b7b98b803ba9197d90" %} +yarn install -{% hint style="info" %} -**Good to know:** A succinct video overview is a great way to introduce folks to your product. Embed a Loom, Vimeo or YouTube video and you're good to go! We love this video from the fine folks at [Loom](https://loom.com) as a perfect example of a succinct feature overview. -{% endhint %} +`` ### Guides: Jump right in Follow our handy guides to get started on the basics as quickly as possible: -{% content-ref url="guides/creating-your-first-project.md" %} -[creating-your-first-project.md](guides/creating-your-first-project.md) +{% content-ref url="guias/creating-your-first-project.md" %} +[creating-your-first-project.md](guias/creating-your-first-project.md) {% endcontent-ref %} -{% content-ref url="guides/creating-your-first-task.md" %} -[creating-your-first-task.md](guides/creating-your-first-task.md) +{% content-ref url="guias/creating-your-first-task.md" %} +[creating-your-first-task.md](guias/creating-your-first-task.md) {% endcontent-ref %} -{% content-ref url="guides/advanced-permissions.md" %} -[advanced-permissions.md](guides/advanced-permissions.md) +{% content-ref url="guias/advanced-permissions.md" %} +[advanced-permissions.md](guias/advanced-permissions.md) {% endcontent-ref %} {% hint style="info" %} @@ -70,25 +65,22 @@ Learn the fundamentals of MyProduct to get a deeper understanding of our main fe {% hint style="info" %} **Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them. Combine guides with this approach to 'fundamentals' and you're well on your way to great documentation! {% endhint %} -======= -## Bienvenido a AlamedaCMS -Cms básico, basado en Symfony para entornos con acceso ssh y pleno control del server (ej. VPS), incluye reservas ([payunpile][6]) y enlaces ([incalinks][7]) +\======= ## Bienvenido a AlamedaCMS +Cms básico, basado en Symfony para entornos con acceso ssh y pleno control del server (ej. VPS), incluye reservas ([payunpile](https://github.com/gerMdz/payunpile)) y enlaces ([incalinks](https://germdz.github.io/incalinks/)) ### ¿Que resuelve? -Tener CMS basado en estándares modernos, donde pueda tener pleno control del código, y con un [framework][1] líder en PHP como lo es [Symfony][1] -Fácil de actualizar, fácil de mantener, con un árbol de directorios claro. + +Tener CMS basado en estándares modernos, donde pueda tener pleno control del código, y con un [framework](https://symfony.com) líder en PHP como lo es [Symfony](https://symfony.com) Fácil de actualizar, fácil de mantener, con un árbol de directorios claro. ### ¿Qué más tiene? -Tiene un manejo básico de usuarios para la administración de los contenidos. -Permite la creación de reservas para eventos, basado en (PayunPILE)[6]. -Permite la creación de sus propios enlaces cortos, cuando dependa de vínculos de terceros. [IncaLINKS][7] +Tiene un manejo básico de usuarios para la administración de los contenidos. Permite la creación de reservas para eventos, basado en (PayunPILE)[6](https://github.com/gerMdz/payunpile). Permite la creación de sus propios enlaces cortos, cuando dependa de vínculos de terceros. [IncaLINKS](https://germdz.github.io/incalinks/) ### ¿Cómo lo obtengo? -Para usar AlamedaCMS debes bajarlo de [github][8], y luego bajar sus dependencias de paquetes. +Para usar AlamedaCMS debes bajarlo de [github](https://github.com/gerMdz/AlamedaCMS.git), y luego bajar sus dependencias de paquetes. ``` git clone https://github.com/gerMdz/AlamedaCMS.git @@ -97,38 +89,33 @@ composer install yarn install ``` - -Requerimientos ------------- +## Requerimientos * PHP 7.2.9 o superior; * PDO-SQLite PHP extension enabled (o el PDO para tu base de datos); -* y los [usuales requerimientos de una aplicación Symfony][2]. +* y los [usuales requerimientos de una aplicación Symfony](https://symfony.com/doc/current/reference/requirements.html). -Uso ------ +## Uso Las configuraciones básicas son + * la URL de su base de datos ej.: - * DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.7 + * DATABASE\_URL=mysql://db\_user:db\_password@127.0.0.1:3306/db\_name?serverVersion=5.7 * el DSN de su servidor smtp de correos - * MAILER_DSN=smtp://localhost + * MAILER\_DSN=smtp://localhost -Luego con el binario de [Symfony][4], ejecute los siguientes comandos que crearan los datos básicos de usuarios y un contenido de inicio: +Luego con el binario de [Symfony](https://symfony.com/download), ejecute los siguientes comandos que crearan los datos básicos de usuarios y un contenido de inicio: ```bash $ php bin/console doctrine:fixtures:load $ symfony serve -d ``` -Luego acceda a la aplicación en su navegador con la URL dada ( generalmente). +Luego acceda a la aplicación en su navegador con la URL dada ([https://localhost:8000](https://localhost:8000) generalmente). -Si no tiene instalado el binario de Symfony, ejecute `php -S localhost:8000 -t public/` -para utilizar el servidor web PHP incorporado o [configure un servidor web][3] como Nginx o -Apache para ejecutar la aplicación. +Si no tiene instalado el binario de Symfony, ejecute `php -S localhost:8000 -t public/` para utilizar el servidor web PHP incorporado o [configure un servidor web](https://symfony.com/doc/current/cookbook/configuration/web\_server\_configuration.html) como Nginx o Apache para ejecutar la aplicación. -Tests ------ +## Tests Ejecute este comando para correr los tests: @@ -136,22 +123,10 @@ Ejecute este comando para correr los tests: $ ./bin/phpunit ``` - #### AlamedaCMS se base en -- [Symfony][1] framework PHP. -- [Bootstrap](https://getbootstrap.com/) plantillas. -- [FontAwesome](https://fortawesome.github.io/Font-Awesome/) icons. - -Con licencia [MIT](https://github.com/gerMdz/AlamedaCMS/blob/AlamedaCMS/LICENSE) -Uso [PhpStorm][5] - -[1]: https://symfony.com -[2]: https://symfony.com/doc/current/reference/requirements.html -[3]: https://symfony.com/doc/current/cookbook/configuration/web_server_configuration.html -[4]: https://symfony.com/download -[5]: https://jb.gg/OpenSource. -[6]: https://github.com/gerMdz/payunpile -[7]: https://germdz.github.io/incalinks/ -[8]: https://github.com/gerMdz/AlamedaCMS.git +* [Symfony](https://symfony.com) framework PHP. +* [Bootstrap](https://getbootstrap.com) plantillas. +* [FontAwesome](https://fortawesome.github.io/Font-Awesome/) icons. +Con licencia [MIT](https://github.com/gerMdz/AlamedaCMS/blob/AlamedaCMS/LICENSE) Uso [PhpStorm](https://jb.gg/OpenSource.) diff --git a/SUMMARY.md b/SUMMARY.md index aa396da1..06fc1903 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,12 +1,12 @@ # Table of contents -* [What is MyProduct?](README.md) +* [¿Qué es AlamedaCMS?](README.md) -## Guides +## Guías -* [Creating your first project](guides/creating-your-first-project.md) -* [Creating your first task](guides/creating-your-first-task.md) -* [Advanced permissions](guides/advanced-permissions.md) +* [Creating your first project](guias/creating-your-first-project.md) +* [Creating your first task](guias/creating-your-first-task.md) +* [Advanced permissions](guias/advanced-permissions.md) ## Fundamentals diff --git a/guides/advanced-permissions.md b/guias/advanced-permissions.md similarity index 100% rename from guides/advanced-permissions.md rename to guias/advanced-permissions.md diff --git a/guides/creating-your-first-project.md b/guias/creating-your-first-project.md similarity index 100% rename from guides/creating-your-first-project.md rename to guias/creating-your-first-project.md diff --git a/guides/creating-your-first-task.md b/guias/creating-your-first-task.md similarity index 100% rename from guides/creating-your-first-task.md rename to guias/creating-your-first-task.md