From ee74b3dcaca6f216d81de99b82808991f2b9b6e2 Mon Sep 17 00:00:00 2001 From: adam-balogh <52528546+adam-balogh@users.noreply.github.com> Date: Thu, 4 Jul 2019 13:39:29 +0200 Subject: [PATCH 1/7] Delete .gitignore --- .gitignore | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 .gitignore diff --git a/.gitignore b/.gitignore deleted file mode 100644 index c38fa4e..0000000 --- a/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.idea -*.iml From a5be624d9a0b7bd04030d37019410801e27f9c5e Mon Sep 17 00:00:00 2001 From: adam-balogh <52528546+adam-balogh@users.noreply.github.com> Date: Thu, 4 Jul 2019 13:41:00 +0200 Subject: [PATCH 2/7] Delete DevportalAdminEventSubscriber.php --- .../DevportalAdminEventSubscriber.php | 45 ------------------- 1 file changed, 45 deletions(-) delete mode 100644 src/EventSubscriber/DevportalAdminEventSubscriber.php diff --git a/src/EventSubscriber/DevportalAdminEventSubscriber.php b/src/EventSubscriber/DevportalAdminEventSubscriber.php deleted file mode 100644 index 1d650fa..0000000 --- a/src/EventSubscriber/DevportalAdminEventSubscriber.php +++ /dev/null @@ -1,45 +0,0 @@ -configFactory = $configFactory; - } - - /** - * {@inheritdoc} - */ - protected function alterRoutes(RouteCollection $collection) { - if ($this->configFactory->get('node.settings')->get('use_admin_theme')) { - /** @var \Symfony\Component\Routing\Route $route */ - foreach ($collection->all() as $name => $route) { - if (preg_match('/^entity\.api_[a-z0-9_]+\.(add|edit)_form$/i', $name)) { - $route->setOption('_admin_route', TRUE); - } - } - } - } - -} From d1e8422423638d69abb00029f15aa1e56e2c0751 Mon Sep 17 00:00:00 2001 From: adam-balogh <52528546+adam-balogh@users.noreply.github.com> Date: Thu, 4 Jul 2019 14:19:29 +0200 Subject: [PATCH 3/7] Update README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d9b66ad..5131a8e 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,51 @@ INTRODUCTION ------------ The Devportal module allows you to expose API reference documentation by -uploading Swagger/OpenAPI files - as well as create, edit, import and publish +publishing Swagger/OpenAPI files - as well as create, edit, import and publish conceptual documentation on your Drupal site. * For a full description of the module, visit the project page: https://www.drupal.org/project/devportal - - * To submit bug reports and feature suggestions, or to track changes: + + * To fully understand the capabilites of the 'Page builder' module, read this overview: + https://docs.pronovix.net/devportal_product/components/content_management/advanced_content_management + + * For more informations about the 'FAQ' module, click here: + https://docs.pronovix.net/devportal_product/components/content_management/faq + + * For content editors, we recommend to read the folowing page about the 'Guides' module: + https://docs.pronovix.net/devportal_product/components/user_guides + + * To submit bug reports and feature suggestions, or to track changes: https://www.drupal.org/project/issues/devportal REQUIREMENTS ------------ -This module requires no modules outside of Drupal core. +This module requires only Drupal core, but optional modules can be added, such as: + +* [Apigee Edge](https://www.drupal.org/project/apigee_edge) + +* [Contact Emails](https://www.drupal.org/project/contact_emails) + +* [EU Cookie Compilance](https://www.drupal.org/project/eu_cookie_compliance) + +* [Google TagManager](https://www.drupal.org/project/google_tag) + +* [Honeypot](https://www.drupal.org/project/honeypot) + +* [Metatag](https://www.drupal.org/project/metatag) + +* [Node view permissions](https://www.drupal.org/project/node_view_permissions) + +* [Pathauto](https://www.drupal.org/project/pathauto) + +* [Redirect](https://www.drupal.org/project/redirect) + +* [Swagger UI Field Formatter](https://www.drupal.org/project/swagger_ui_formatter) + +* [Views Accordion](https://www.drupal.org/project/views_accordion) INSTALLATION From 413bc03712c37745113ac71d7110a946144ad9ed Mon Sep 17 00:00:00 2001 From: adam-balogh <52528546+adam-balogh@users.noreply.github.com> Date: Thu, 4 Jul 2019 15:19:10 +0200 Subject: [PATCH 4/7] Update README.md --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5131a8e..42354f3 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,14 @@ conceptual documentation on your Drupal site. * For a full description of the module, visit the project page: https://www.drupal.org/project/devportal - * To fully understand the capabilites of the 'Page builder' module, read this overview: - https://docs.pronovix.net/devportal_product/components/content_management/advanced_content_management + * To submit bug reports and feature suggestions, or to track changes: + https://www.drupal.org/project/issues/devportal + + * The customization capabilites of the Devportal module can be expanded by the 'Page builder' module. With it, the user can create highly customisable pages with reusable building blocks. - * For more informations about the 'FAQ' module, click here: - https://docs.pronovix.net/devportal_product/components/content_management/faq + * You can add the 'FAQ' custom module to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. - * For content editors, we recommend to read the folowing page about the 'Guides' module: - https://docs.pronovix.net/devportal_product/components/user_guides - - * To submit bug reports and feature suggestions, or to track changes: - https://www.drupal.org/project/issues/devportal + * If you are a content editor, we recommend you to enable the 'Guides' module, which describes the custom functionalities and collects the links for the related core drupal functionalities. REQUIREMENTS From eda91bf3b93dbf3a88bde272fa206196e9c44f88 Mon Sep 17 00:00:00 2001 From: adam-balogh <52528546+adam-balogh@users.noreply.github.com> Date: Fri, 5 Jul 2019 09:29:48 +0200 Subject: [PATCH 5/7] fixed typos and grammar --- README.md | 39 ++++++++++++++------------------------- 1 file changed, 14 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 42354f3..15d49e9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -CONTENTS OF THIS FILE ---------------------- +# CONTENTS OF THIS FILE * Introduction * Requirements @@ -7,9 +6,7 @@ CONTENTS OF THIS FILE * Configuration * Maintainers - -INTRODUCTION ------------- +# INTRODUCTION The Devportal module allows you to expose API reference documentation by publishing Swagger/OpenAPI files - as well as create, edit, import and publish @@ -17,19 +14,17 @@ conceptual documentation on your Drupal site. * For a full description of the module, visit the project page: https://www.drupal.org/project/devportal - + * To submit bug reports and feature suggestions, or to track changes: https://www.drupal.org/project/issues/devportal - - * The customization capabilites of the Devportal module can be expanded by the 'Page builder' module. With it, the user can create highly customisable pages with reusable building blocks. - - * You can add the 'FAQ' custom module to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. - - * If you are a content editor, we recommend you to enable the 'Guides' module, which describes the custom functionalities and collects the links for the related core drupal functionalities. + * The customization capabilities of the Devportal module can be expanded by the 'Page builder' module. With it, the user can create highly customizable pages with reusable building blocks. + + * You can add the 'FAQ' custom module to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. + + * We recommend you to enable the 'Guides' module, which describes the custom functionalities and collects the links for the related core Drupal capabilities. It is a useful tool for content editors. -REQUIREMENTS ------------- +# REQUIREMENTS This module requires only Drupal core, but optional modules can be added, such as: @@ -37,9 +32,9 @@ This module requires only Drupal core, but optional modules can be added, such a * [Contact Emails](https://www.drupal.org/project/contact_emails) -* [EU Cookie Compilance](https://www.drupal.org/project/eu_cookie_compliance) +* [EU Cookie Compliance](https://www.drupal.org/project/eu_cookie_compliance) -* [Google TagManager](https://www.drupal.org/project/google_tag) +* [Google Tag Manager](https://www.drupal.org/project/google_tag) * [Honeypot](https://www.drupal.org/project/honeypot) @@ -55,9 +50,7 @@ This module requires only Drupal core, but optional modules can be added, such a * [Views Accordion](https://www.drupal.org/project/views_accordion) - -INSTALLATION ------------- +# INSTALLATION * Install the Developer portal module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for @@ -68,17 +61,13 @@ INSTALLATION README of the latter, as it might contain some useful Composer-related information about pulling in its JS dependencies. - -CONFIGURATION -------------- +# CONFIGURATION 1. Navigate to Administration > Extend and enable the module. 2. Navigate to Administration > Devportal > Configuration to manage Devportal configurations. - -MAINTAINERS ------------ +# MAINTAINERS * tamasd - https://www.drupal.org/u/tamasd * Balazs Wittmann (balazswmann) - https://www.drupal.org/u/balazswmann From be3f6de9ddc217b1044d7b90897202d86baf677a Mon Sep 17 00:00:00 2001 From: adam-balogh <52528546+adam-balogh@users.noreply.github.com> Date: Fri, 5 Jul 2019 11:30:27 +0200 Subject: [PATCH 6/7] Update README.md unnecessary lines have been deleted, reference is added, terms have been fixed --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 15d49e9..3a01636 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ * Configuration * Maintainers -# INTRODUCTION +## INTRODUCTION The Devportal module allows you to expose API reference documentation by publishing Swagger/OpenAPI files - as well as create, edit, import and publish @@ -18,13 +18,12 @@ conceptual documentation on your Drupal site. * To submit bug reports and feature suggestions, or to track changes: https://www.drupal.org/project/issues/devportal - * The customization capabilities of the Devportal module can be expanded by the 'Page builder' module. With it, the user can create highly customizable pages with reusable building blocks. + * You can add the 'FAQ' submodule to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. - * You can add the 'FAQ' custom module to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. + * We recommend you to enable the 'Guides' module, which gives the ability for writers to upload docs in Markdown. It is a useful tool for content editors. Read more here: +https://github.com/Pronovix/devportal-drupal-module/blob/8.x-2.x/modules/guides/README.md - * We recommend you to enable the 'Guides' module, which describes the custom functionalities and collects the links for the related core Drupal capabilities. It is a useful tool for content editors. - -# REQUIREMENTS +## REQUIREMENTS This module requires only Drupal core, but optional modules can be added, such as: @@ -50,7 +49,7 @@ This module requires only Drupal core, but optional modules can be added, such a * [Views Accordion](https://www.drupal.org/project/views_accordion) -# INSTALLATION +## INSTALLATION * Install the Developer portal module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for @@ -61,13 +60,13 @@ This module requires only Drupal core, but optional modules can be added, such a README of the latter, as it might contain some useful Composer-related information about pulling in its JS dependencies. -# CONFIGURATION +## CONFIGURATION 1. Navigate to Administration > Extend and enable the module. 2. Navigate to Administration > Devportal > Configuration to manage Devportal configurations. -# MAINTAINERS +## MAINTAINERS * tamasd - https://www.drupal.org/u/tamasd * Balazs Wittmann (balazswmann) - https://www.drupal.org/u/balazswmann From 603da00f3eee9bb049280f5e65b59d15a0f199f1 Mon Sep 17 00:00:00 2001 From: adam-balogh <52528546+adam-balogh@users.noreply.github.com> Date: Fri, 5 Jul 2019 11:57:05 +0200 Subject: [PATCH 7/7] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a01636..d14fd1f 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ conceptual documentation on your Drupal site. * You can add the 'FAQ' submodule to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. - * We recommend you to enable the 'Guides' module, which gives the ability for writers to upload docs in Markdown. It is a useful tool for content editors. Read more here: -https://github.com/Pronovix/devportal-drupal-module/blob/8.x-2.x/modules/guides/README.md + * We recommend you to enable the 'Guides' submodule, which gives the ability for writers to upload docs in Markdown. It is a useful tool for content editors. Read more [here](/modules/guides/README.md). + ## REQUIREMENTS