Merge pull request #32 from 21TORR/janus-php

Enhance Janus PHP docs
21TORR · Apr 30, 2024 · 8a1b2bb · 8a1b2bb
2 parents 085d3a6 + ad3cad6
commit 8a1b2bb
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/blog/2024-04-30-janus-php.mdx b/blog/2024-04-30-janus-php.mdx
@@ -9,4 +9,17 @@ tags: [janus]
 - `21torr/php-cs` is now deprecated, the docs were removed.
 
 
+## Migrating from php-cs to Janus PHP
+
+You should migrate from `php-cs` to [Janus PHP] as soon as possible.
+
+You should start with removing the old `vendor-bin` directories:
+
+```shell
+rm -rf vendor-bin
+```
+
+Then proceed with regularly installing Janus.
+
+
 [Janus PHP]:  /docs/php/tooling/janus-php
diff --git a/docs/php/tooling/janus-php/index.mdx → docs/php/tooling/janus-php.mdx b/docs/php/tooling/janus-php/index.mdx → docs/php/tooling/janus-php.mdx
@@ -1,4 +1,4 @@
-import {LinkList} from "../../../../src/components/Link/LinkList";
+import {LinkList} from "../../../src/components/Link/LinkList";
 
 # Janus PHP
 
@@ -69,6 +69,18 @@ composer run-script lint
 composer run-script test
 ```
 
+## Integration in CI
+
+Your CI should just use the composer scripts:
+
+```yaml title=".gitlab-ci.yml"
+"Build App":
+    script:
+        - "composer install --optimize-autoloader --classmap-authoritative --no-interaction"
+        - "composer run-script lint"
+        - "composer run-script test"
+```
+
 
 
 ## PHP CS Fixer

diff --git a/docs/php/tooling/php-cs-fixer/index.mdx → docs/php/tooling/php-cs-fixer.mdx b/docs/php/tooling/php-cs-fixer/index.mdx → docs/php/tooling/php-cs-fixer.mdx
@@ -1,4 +1,4 @@
-import {LinkList} from "../../../../src/components/Link/LinkList";
+import {LinkList} from "../../../src/components/Link/LinkList";
 
 # PHP-CS-Fixer
 

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -182,6 +182,7 @@ const config = {
 					"json5",
 					"php",
 					"twig",
+					"yaml",
 				],
 			},
 		}),
-Original file line number
+Diff line change
@@ Expand Up / @@ -182,6 +182,7 @@ const config = { @@
     					"json5",
     					"php",
     					"twig",
+    					"yaml",
     				],
     			},
     		}),
@@ Expand Down @@