diff --git a/.deployer/inventory.yml b/.deployer/inventory.yml deleted file mode 100644 index d0cf9dc..0000000 --- a/.deployer/inventory.yml +++ /dev/null @@ -1,19 +0,0 @@ -servers: - - - name: deployerphp - host: 165.245.136.228 - port: 22 - username: root - privateKeyPath: ~/.ssh/id_ed25519 - provider: digitalocean - dropletId: 547535778 - instanceId: null -sites: - - - domain: deployerphp.com - server: deployerphp - repo: 'git@github.com:loadinglucian/deployerphp.com.git' - branch: main - php_version: '8.5' - www_mode: redirect-to-root - has_www: true diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..cfa5894 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,12 @@ +{ + "MD007": false, + "MD013": false, + "MD033": { + "allowed_elements": [ + "a", + "img", + "p" + ] + }, + "MD041": false +} diff --git a/README.md b/README.md index 0165a77..8684d6f 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,44 @@ -

Laravel Logo

-

-Build Status -Total Downloads -Latest Stable Version -License + + DeployerPHP Logo +

-## About Laravel - -Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: - -- [Simple, fast routing engine](https://laravel.com/docs/routing). -- [Powerful dependency injection container](https://laravel.com/docs/container). -- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. -- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). -- Database agnostic [schema migrations](https://laravel.com/docs/migrations). -- [Robust background job processing](https://laravel.com/docs/queues). -- [Real-time event broadcasting](https://laravel.com/docs/broadcasting). - -Laravel is accessible, powerful, and provides tools required for large, robust applications. - -## Learning Laravel - -Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. You can also check out [Laravel Learn](https://laravel.com/learn), where you will be guided through building a modern Laravel application. +# DeployerPHP Documentation Site -If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. +This is the documentation site for [DeployerPHP](https://github.com/loadinglucian/deployer-php), a complete set of CLI tools for provisioning, installing, and deploying servers and sites using PHP. -## Laravel Sponsors +It is a Laravel + Livewire application that renders the DeployerPHP documentation as a beautiful, browsable website. The documentation content itself is not stored in this repository — it is read at runtime from the `docs` folder of the `loadinglucian/deployer-php` Composer dependency. -We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com). +> [!NOTE] +> This site is no longer hosted online. Clone this repository and run it locally to browse the documentation as a website. Alternatively, you can read the markdown files directly in the [deployer-php docs folder](https://github.com/loadinglucian/deployer-php/tree/main/docs). -### Premium Partners +## Requirements -- **[Vehikl](https://vehikl.com)** -- **[Tighten Co.](https://tighten.co)** -- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** -- **[64 Robots](https://64robots.com)** -- **[Curotec](https://www.curotec.com/services/technologies/laravel)** -- **[DevSquad](https://devsquad.com/hire-laravel-developers)** -- **[Redberry](https://redberry.international/laravel-development)** -- **[Active Logic](https://activelogic.com)** +- PHP 8.5+ and Composer +- Node.js and npm (for building assets) +- A [Flux Pro](https://fluxui.dev) license — the UI depends on `livewire/flux-pro`, which requires Composer credentials for `composer.fluxui.dev` (see the [Flux installation docs](https://fluxui.dev/docs/installation)) -## Contributing +## Running Locally -Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). +```shell +git clone https://github.com/loadinglucian/deployerphp.com.git +cd deployerphp.com -## Code of Conduct +# Install dependencies, create .env, generate app key, +# run migrations, and build frontend assets +composer run setup -In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). +# Start the local dev servers (app, queue, logs, vite) +composer run dev +``` -## Security Vulnerabilities +Then open to browse the documentation. A command reference is available at . -If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed. +## Previewing Local Documentation Changes -## License +By default, the site renders the documentation shipped with the `loadinglucian/deployer-php` Composer package (`vendor/loadinglucian/deployer-php/docs`). To preview documentation changes from a local checkout instead, point `DOCS_PATH` at it in your `.env`: -The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). +```dotenv +DOCS_PATH=/path/to/deployer-php/docs +```