Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[6.x] Documentation upgrade #170

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 0 additions & 53 deletions .github/workflows/docs.yml

This file was deleted.

13 changes: 0 additions & 13 deletions .run/build.run.xml

This file was deleted.

13 changes: 0 additions & 13 deletions .run/dev.run.xml

This file was deleted.

6 changes: 6 additions & 0 deletions docs/c.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="wrs" name="Writerside documentation" order="1"/>
</categories>
38 changes: 38 additions & 0 deletions docs/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<variables>
<!-- <algolia-api-key>1830e628456a000ddfeb32941f42a78c</algolia-api-key>-->
<!-- <algolia-id>K2N865FUBK</algolia-id>-->
<!-- <algolia-index>laravel-lang</algolia-index>-->
<generate-canonicals>true</generate-canonicals>
<header-logo>logo.svg</header-logo>
<locale-code>en_US</locale-code>
<og-image>
https://raw.githubusercontent.com/TheDragonCode/art/main/splash/github.png
</og-image>
<color-preset>contrast</color-preset>
<primary-color>frozen</primary-color>
<web-root>https://deploy-operations.dragon-code.pro</web-root>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>
https://github.com/TheDragonCode/laravel-deploy-operations/edit/main/docs/
</browser-edits-url>
<custom-favicons>
favicon.svg,favicon.svg,favicon.svg,favicon.svg
</custom-favicons>
</variables>
<build-profile instance="deploy-operations">
<variables>
<noindex-content>false</noindex-content>
</variables>
</build-profile>
<sitemap priority="0.5" change-frequency="weekly"/>
<footer>
<link href="https://github.com/TheDragonCode/laravel-deploy-operations">
GitHub
</link>
<link href="https://github.com/TheDragonCode/laravel-deploy-operations/issues">
Issues
</link>
</footer>
</buildprofiles>
11 changes: 11 additions & 0 deletions docs/deploy-operations.tree
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="deploy-operations"
name="Laravel Deploy Operations"
start-page="introduction.topic">

<toc-element topic="introduction.topic"/>
<toc-element topic="license.topic" toc-title="License"/>
</instance-profile>
1 change: 1 addition & 0 deletions docs/images/badge-not-supported.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/badge-not-supported_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/badge-supported.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/badge-supported_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docs/images/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 0 additions & 42 deletions docs/index.md

This file was deleted.

Empty file added docs/snippets/.gitkeep
Empty file.
41 changes: 41 additions & 0 deletions docs/topics/introduction.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Introduction" id="introduction">

<p>
<img
src="https://preview.dragon-code.pro/the-dragon-code/deploy-operations.svg?brand=laravel&amp;mode=dark"
alt="%instance%"
/>
</p>
<p>
<a href="%link-packagist%"><img src="%badge-stable%" alt="stable"/></a>
<a href="%link-repository%"><img src="%badge-downloads%" alt="downloads"/></a>
<a href="%link-workflows%"><img src="%badge-build%" alt="build"/></a>
<a href="license.topic"><img src="%badge-license%" alt="license"/></a>
</p>
<p>
<control>Performing any actions during the deployment process</control>
</p>
<p>
Create specific classes for a one-time or more-time usage, that can be executed automatically after each
deployment.
Perfect for seeding or updating some data instantly after some database changes, feature updates, or perform any
actions.
</p>
<p>
This package is for you if...
</p>
<list>
<li>you regularly need to update specific data after you deploy new code</li>
<li>you often perform jobs after deployment</li>
<li>you sometimes forget to execute that one specific job and stuff gets crazy</li>
<li>your code gets cluttered with jobs that are not being used anymore</li>
<li>your co-workers always need to be reminded to execute that one job after some database changes</li>
<li>you often seed or process data in a migration file (which is a big no-no!)</li>
</list>
</topic>
28 changes: 28 additions & 0 deletions docs/topics/license.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="MIT License" id="license">

<p>
Copyright (c) %year% %team-name%
</p>
<p>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the “Software”), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
</p>
<p>
The above copyright notice and this permission notice shall be included in all copies or substantial portions
of the Software.
</p>
<p>
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</p>
</topic>
26 changes: 26 additions & 0 deletions docs/v.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
<vars>
<var name="badge-not-supported" value="badge-not-supported.svg"/>
<var name="badge-supported" value="badge-supported.svg"/>
<var name="command-operations" value="php artisan operations"/>
<var name="command-fresh" value="php artisan operations:fresh"/>
<var name="command-install" value="php artisan operations:install"/>
<var name="command-make:operation" value="php artisan make:operation"/>
<var name="command-refresh" value="php artisan operations:refresh"/>
<var name="command-reset" value="php artisan operations:reset"/>
<var name="command-rollback" value="php artisan operations:rollback"/>
<var name="command-status" value="php artisan operations:status"/>
<var name="command-upgrade" value="php artisan operations:upgrade"/>
<var name="config-filename" value="config/deploy-operations.php"/>
<var name="install-package" value="composer require dragon-code/laravel-deploy-operations"/>
<var name="team-name" value="The Dragon Code" />
<var name="year" value="2024" />
<var name="badge-stable" value="https://img.shields.io/github/v/release/TheDragonCode/laravel-actions?label=packagist&amp;style=flat-square" />
<var name="badge-build" value="https://img.shields.io/github/actions/workflow/status/TheDragonCode/laravel-actions/phpunit.yml?style=flat-square" />
<var name="badge-downloads" value="https://img.shields.io/packagist/dt/dragon-code/laravel-actions.svg?style=flat-square" />
<var name="badge-license" value="https://img.shields.io/packagist/l/dragon-code/laravel-deploy-operations.svg?style=flat-square" />
<var name="link-packagist" value="https://packagist.org/packages/dragon-code/laravel-deploy-operations" />
<var name="link-repository" value="https://github.com/TheDragonCode/laravel-deploy-operations" />
<var name="link-workflows" value="https://github.com/TheDragonCode/laravel-deploy-operations/actions" />
</vars>
9 changes: 9 additions & 0 deletions docs/writerside.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">

<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<snippets src="snippets"/>
<instance src="deploy-operations.tree" web-path="/"/>
</ihp>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
29 changes: 0 additions & 29 deletions package.json

This file was deleted.