diff --git a/.gitignore b/.gitignore deleted file mode 100644 index c38fa4e..0000000 --- a/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.idea -*.iml diff --git a/README.md b/README.md index d9b66ad..d14fd1f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -CONTENTS OF THIS FILE ---------------------- +# CONTENTS OF THIS FILE * Introduction * Requirements @@ -7,12 +6,10 @@ CONTENTS OF THIS FILE * Configuration * Maintainers - -INTRODUCTION ------------- +## 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: @@ -21,15 +18,38 @@ conceptual documentation on your Drupal site. * To submit bug reports and feature suggestions, or to track changes: https://www.drupal.org/project/issues/devportal + * 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' 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 + +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 Compliance](https://www.drupal.org/project/eu_cookie_compliance) -REQUIREMENTS ------------- +* [Google Tag Manager](https://www.drupal.org/project/google_tag) -This module requires no modules outside of Drupal core. +* [Honeypot](https://www.drupal.org/project/honeypot) +* [Metatag](https://www.drupal.org/project/metatag) -INSTALLATION ------------- +* [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 * Install the Developer portal module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for @@ -40,17 +60,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 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); - } - } - } - } - -}