From c23c9e1e2f83812d03317be5678fad1c008fec72 Mon Sep 17 00:00:00 2001
From: jurgenhaas <juergen@paragon-es.de>
Date: Tue, 12 Jan 2021 14:37:09 +0100
Subject: [PATCH] Move readme to docs
---
README.md | 35 -----------------------------------
composer.json | 3 ++-
2 files changed, 2 insertions(+), 36 deletions(-)
delete mode 100644 README.md
diff --git a/README.md b/README.md
deleted file mode 100644
index 72134b8..0000000
--- a/README.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# Dorgflow Composer Plugin
-
-This is a composer plugin which prepares some of your projects in a composer based Drupal installation for drupal-org contributions powered by [Dorgflow](https://github.com/joachim-n/dorgflow).
-
-## Installation
-
-If you're using the [Drupal Development Environment](https://gitlab.lakedrops.com/composer/plugin/drupal-development-environment), everything is already available for you. Otherwise call `composer require --dev lakedrops/dorgflow` and everything will be taken care off for you automatically - even if you update your Drupal project at any time in the future, the development environments for your defined projects will be kept in place and properly configured.
-
-## Configuration
-
-Add a dorgflow section to your `.lakedrops.yml` with a list of all the project you want to maintain given their respective versions:
-
-```yaml
----
-dorgflow:
- projects:
- drupal/colorbox_field_formatter: 8.x-1.x
- drupal/dimension: 8.x-1.x
- drupal/drd: 8.x-3.x
- drupal/drd_agent: 8.x-3.x
- drupalspoons:
- drupal/devel: 1.x-dev
- selfhosted:
- url: gitlab.lakedrops.com
- projects:
- lakedrops/docker4drupal:
- path: composer/plugins
- version: develop
-```
-
-## Usage
-
-There are basicly two different use cases: for projects that you keep maintaining for a longer period of time, you add them to the extra/dorgflow section in your composer.json and when ever you run `composer update`, this will also refresh those projects and re-clone the projects so that you can continue maintaining them in you development environment.
-
-For projects, you have a spontaneous need, e.g. for writing a patch to an issue, there is a quick way to achieve the same without having to run `composer update`. Simply add the project to the extra/dorgflow section as well and then call `composer lakedrops:dorgflow`. This will just checkout all the projects in this section if needed and you're ready to go.
diff --git a/composer.json b/composer.json
index dbbaea7..b39b2d9 100644
--- a/composer.json
+++ b/composer.json
@@ -21,7 +21,8 @@
],
"support": {
"issues": "https://gitlab.lakedrops.com/composer/plugin/dorgflow/issues",
- "source": "https://gitlab.lakedrops.com/composer/plugin/dorgflow/tree/master"
+ "source": "https://gitlab.lakedrops.com/composer/plugin/dorgflow/tree/master",
+ "docs": "https://devops-tools.docs.lakedrops.com/composer/plugin/dorgflow/"
},
"require": {
"php": ">=7.2",
--
GitLab