From 6c12f75006a77baec82f046fa0a17baff9d8e760 Mon Sep 17 00:00:00 2001 From: Christoph Reiter <reiter.christoph@gmail.com> Date: Mon, 16 May 2022 16:21:04 +0200 Subject: [PATCH] Still keep a simple docs structure So we can continue linking it from the dev-docs, so we can innclude it like every other bundle. --- README.md | 13 +------------ docs/index.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 12 deletions(-) create mode 100644 docs/index.md diff --git a/README.md b/README.md index 360bd99..1f39da7 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,4 @@ [GitLab](https://gitlab.tugraz.at/dbp/relay/dbp-relay-core-bundle) | [Packagist](https://packagist.org/packages/dbp/relay-core-bundle) -The core bundle is the central bundle that needs to be installed in every Relay API -gateway and also is a dependency of every other API bundle. - -* It provides functionality that is commonly needed by API bundles (error handling, - logging, etc) -* It integrates the auth bundle with the Symfony security system -* It provides console commands that API bundles can subscribe to -* It configures all dependencies to our needs (api-platform, symfony, etc.) -* and more ... - -For more information on how to configure and interface with the core bundle see -the [Developer Guide](https://dbp-demo.tugraz.at/dev-guide/relay/dev/) +Docs: see <https://gitlab.tugraz.at/dbp/relay/dbp-relay-core-bundle/-/tree/main/docs> \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e3e516f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,14 @@ +# About + +The core bundle is the central bundle that needs to be installed in every Relay API +gateway and also is a dependency of every other API bundle. + +* It provides functionality that is commonly needed by API bundles (error handling, + logging, etc) +* It integrates the auth bundle with the Symfony security system +* It provides console commands that API bundles can subscribe to +* It configures all dependencies to our needs (api-platform, symfony, etc.) +* and more ... + +For more information on how to configure and interface with the core bundle see +the [Developer Guide](https://dbp-demo.tugraz.at/dev-guide/relay/dev/) \ No newline at end of file -- GitLab