diff --git a/docs/introduction.md b/docs/introduction.md index 0fb4993..56922b1 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -9,33 +9,3 @@ and community-driven long-term maintenance of packages & libraries based on the Many of the packages found in the LM-Commons repositories are former ZF-Commons packages that were migrated to the Laminas Project framework. - -## LmcUser -LmcUser is a generic user registration and authentication module for Laminas. Supports Laminas\Db and Doctrine2. - -## LmcRbacMvc -LmcRbacMvc is a role-based access control Laminas MVC module to provide additional features on top of Laminas\Permissions\Rbac - -## LmcRbac - -LmcRbac is a role-based access control module to provide additional features on top of Laminas\Permissions\Rbac (formerly zfc-rbac) - -## LmcCors -LmcCors is a simple Laminas MVC module that helps you to deal with Cross-Origin Resource Sharing (CORS). - -## LmcUserDoctrineORM -LmcUserDoctrineORM is a Doctrine2 ORM storage adapter for LmcUser. - -## LmcAdmin -LmcAdmin is an admin interface for Laminas MVC framework. - -## LmcMail -LmcMail is Wrapper for Laminas Mail that uses View Model to compose the email body. - -##### Notices and Disclaimers -This is not an official Laminas Project organization. - -Issues and questions related to the Laminas MVC and components -should be addressed to the Laminas Project organisation. - -Laminas is a trademark of the Laminas Project, a Series of LF Projects, LLC. diff --git a/docs/lmc-admin/01-introduction.md b/docs/lmc-admin/01-introduction.md deleted file mode 100644 index 1d67939..0000000 --- a/docs/lmc-admin/01-introduction.md +++ /dev/null @@ -1,27 +0,0 @@ -# Introduction -> -> This is work in progress to convert to Laminas -> -# LmcAdmin Module for Laminas Framework -Created by [Jurian Sluiman](http://juriansluiman.nl) and [Martin Shwalbe](https://github.com/Hounddog). - -## Introduction -LmcAdmin is a minimal admin interface for generic administrative purposes. It is a common screen with navigation that hides behind authentication and authorization. - -## Installation -LmcAdmin is enabled to be installed via composer. Load `lm-commons/lmc-admin` in your `composer.json` file. You can specify its version (currently only 1.0.0 is recommended) or use `dev-master` to load the latest version from master. Enable LmcAdmin in your `module.config.php` configuration file. - -If you do not want to use composer, clone this project (either as a git submodule or not) into `./vendor/` directory. - -## Usage -LmcAdmin allows you to create routes under a single parent "admin" route. You can also use it to enable navigation in your admin layout. Furthermore integration of [LmcRbacMvc](https://github.com/LM-Commons/LmcRbacMvc) is provided. - -The complete configuration is flexible, so you can update the zfcadmin parent route, its children, the navigation and all default provided view scripts. Read more in the [documentation](docs/lmc-admin/01-introduction.md) about usage and customization of LmcAdmin. - -## Development -LmcAdmin is currently under development. The authors feel LmcAdmin is stable enough for production versions and you can always fix your LmcAdmin version to a specific tag. - -## Support - -- File issues at https://github.com/LM-Commons/LmcAdmin/issues. -- Ask questions in the [LM-Commons gitter](https://gitter.im/LM-Commons/community) chat. \ No newline at end of file diff --git a/docs/lmc-rbac/01-introduction.md b/docs/lmc-rbac/01-introduction.md deleted file mode 100644 index 34e1e08..0000000 --- a/docs/lmc-rbac/01-introduction.md +++ /dev/null @@ -1,12 +0,0 @@ -# Introduction -Role-based access control module to provide additional features on top of Zend\Permissions\Rbac - -Based on [ZF-Commons/zfc-rbac](https://github.com/ZF-Commons/zfc-rbac) v3.x. - -If you are looking for the Laminas version -of zfc-rbac v2, please use [LM-Commons/LmcRbacMvc](https://github.com/LM-Commons/LmcRbacMvc). - -## Support - -- File issues at https://github.com/LM-Commons/LmcRbac/issues. -- Ask questions in the [LM-Commons gitter](https://gitter.im/Lm-Commons/community) chat. diff --git a/docs/lmc-rbac/02-installtion.md b/docs/lmc-rbac/02-installtion.md deleted file mode 100644 index 2f0c9a5..0000000 --- a/docs/lmc-rbac/02-installtion.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -sidebar_label: Requirements and Installation ---- -# Requirements and Installation -## Requirements - -- PHP 7.3 or higher - - -## Installation - -LmcRbac only officially supports installation through Composer. For Composer documentation, please refer to -[getcomposer.org](http://getcomposer.org/). - -Install the module: - -```sh -$ composer require lm-commons/lmc-rbac:^1.1 -``` - -Enable the module by adding `LmcRbac` key to your `application.config.php` file. Customize the module by copy-pasting -the `config.global.php` file to your `config/autoload` folder. - -You can also find some Doctrine entities in the [data](https://github.com/LM-Commons/LmcRbac/tree/master/data) folder that will help you to more quickly take advantage -of LmcRbac. diff --git a/docs/lmc-rbac/_category_.json b/docs/lmc-rbac/_category_.json deleted file mode 100644 index 4077e21..0000000 --- a/docs/lmc-rbac/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "LmcRbac", - "position": 3, - "link": { - "type": "generated-index", - "description": "Role-based access control module to provide additional features on top of Laminas\\Permissions\\Rbac (formerly zfc-rbac)" - } -} diff --git a/docs/LmcCors.md b/docs/packages/LmcCors.md similarity index 100% rename from docs/LmcCors.md rename to docs/packages/LmcCors.md diff --git a/docs/LmcMail.md b/docs/packages/LmcMail.md similarity index 100% rename from docs/LmcMail.md rename to docs/packages/LmcMail.md diff --git a/docs/packages/LmcRbac.md b/docs/packages/LmcRbac.md new file mode 100644 index 0000000..69170db --- /dev/null +++ b/docs/packages/LmcRbac.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 5 +--- + +Role-based access control module to provide additional features on top of Laminas\Permissions\Rbac (formerly zfc-rbac) + +[Documentation](https://lm-commons.github.io/LmcRbac) \ No newline at end of file diff --git a/docs/LmcRbacMvc.md b/docs/packages/LmcRbacMvc.md similarity index 100% rename from docs/LmcRbacMvc.md rename to docs/packages/LmcRbacMvc.md diff --git a/docs/LmcUser.md b/docs/packages/LmcUser.md similarity index 100% rename from docs/LmcUser.md rename to docs/packages/LmcUser.md diff --git a/docs/packages/_category_.json b/docs/packages/_category_.json new file mode 100644 index 0000000..4b6abb1 --- /dev/null +++ b/docs/packages/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Packages", + "position": 2, + "link": { + "type": "generated-index" + } +} diff --git a/docs/packages/lmc-admin/01-introduction.md b/docs/packages/lmc-admin/01-introduction.md new file mode 100644 index 0000000..85b08bf --- /dev/null +++ b/docs/packages/lmc-admin/01-introduction.md @@ -0,0 +1,32 @@ +# Introduction + +### LmcAdmin Module for Laminas Framework +Originally created by [Jurian Sluiman](http://juriansluiman.nl) and [Martin Shwalbe](https://github.com/Hounddog). + +## Introduction +LmcAdmin is a minimal admin interface for generic administrative purposes. It is a common screen with navigation that +hides behind authentication and authorization. + +## Installation +LmcAdmin is enabled to be installed via composer. +Load `lm-commons/lmc-admin` in your `composer.json` file. You can specify its version (currently only 1.0.0 is +recommended) or use `dev-master` to load the latest version from master. Enable LmcAdmin in +your `module.config.php` configuration file. + +If you do not want to use composer, clone this project (either as a git submodule or not) into `./vendor/` directory. + +## Usage +LmcAdmin allows you to create routes under a single parent "admin" route. You can also use it to enable navigation +in your admin layout. Furthermore integration of [LmcRbacMvc](https://github.com/LM-Commons/LmcRbacMvc) is provided. + +The complete configuration is flexible, so you can update the `lmcadmin` parent route, its children, the navigation +and all default provided view scripts. + +## Development +LmcAdmin is currently under development. The authors feel LmcAdmin is stable enough for production versions and +you can always fix your LmcAdmin version to a specific tag. + +## Support + +- File issues at https://github.com/LM-Commons/LmcAdmin/issues. +- Ask questions in the [LM-Commons Slack](https://join.slack.com/t/lm-commons/shared_invite/zt-2gankt2wj-FTS45hp1W~JEj1tWvDsUHQ) chat. \ No newline at end of file diff --git a/docs/lmc-admin/_category_.json b/docs/packages/lmc-admin/_category_.json similarity index 100% rename from docs/lmc-admin/_category_.json rename to docs/packages/lmc-admin/_category_.json diff --git a/docusaurus.config.js b/docusaurus.config.js index 7c07d36..2dd796d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -101,6 +101,10 @@ const config = { href: 'https://lm-commons.github.io/LmcMail/', label: 'LmcMail' }, + { + href: 'https://lm-commons.github.io/LmcRbac/', + label: 'LmcRbac' + }, ] }, { diff --git a/sidebars.js b/sidebars.js index cd47ab5..3e55c22 100644 --- a/sidebars.js +++ b/sidebars.js @@ -15,10 +15,11 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure mainSidebar: [{type: 'autogenerated', dirName: '.'}], + packages: [{type: "autogenerated", dirName: 'packages'}], // lmcRbacMvc: [{type: 'autogenerated', dirName: 'lmc-rbac-mvc'}], // lmcUser: [{type: 'autogenerated', dirName: 'lmc-user'}], // lmcCors: [{type: 'autogenerated', dirName: 'lmc-cors'}], - lmcRbac: [{type: 'autogenerated', dirName: 'lmc-rbac'}], +// lmcRbac: [{type: 'autogenerated', dirName: 'lmc-rbac'}], // lmcMail: [{type: 'autogenerated', dirName: 'lmc-mail'}], // But you can create a sidebar manually diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js index ced1749..0cd1050 100644 --- a/src/components/HomepageFeatures/index.js +++ b/src/components/HomepageFeatures/index.js @@ -51,7 +51,7 @@ const PackageList = [ Role-based access control module to provide additional features on top of Zend\Permissions\Rbac ), - href: '/docs/lmc-rbac/introduction', + href: 'https://lm-commons.github.io/LmcRbac/', }, { title: 'LmcAdmin', @@ -60,7 +60,7 @@ const PackageList = [ LmcAdmin Module for Laminas Framework ), - href: '/docs/lmc-admin/introduction', + href: '/docs/packages/lmc-admin/introduction', }, ]; @@ -116,6 +116,7 @@ function Feature({Svg, title, description}) { } */ +/* function Package({title, description, href}) { return (
@@ -133,6 +134,8 @@ function Package({title, description, href}) { ); } + */ + function PackageCard({title, description, href}) { return (
diff --git a/src/pages/disclaimer.md b/src/pages/disclaimer.md index 9a5dc53..42673e5 100644 --- a/src/pages/disclaimer.md +++ b/src/pages/disclaimer.md @@ -8,4 +8,4 @@ This is not an official Laminas Project organization. Issues and questions related to the Laminas MVC and components should be addressed to the Laminas Project organisation. -Laminas is a trademark of the Laminas Project, a Series of LF Projects, \ No newline at end of file +Laminas is a trademark of the Laminas Project, a Series of LF Projects, LLC. \ No newline at end of file