- Introduction
- Requirements
- Installation
- Configuration
- Maintainers
The Devportal module allows you to expose API reference documentation by 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: 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.
This module requires only Drupal core, but optional modules can be added, such as:
- Install the Developer portal module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further information.
- Make sure the dependencies for all the (sub)modules you want to enable are met (recursively). An example: as the devportal_api_reference submodule depends on the swagger_ui_formatter module, you should also check the README of the latter, as it might contain some useful Composer-related information about pulling in its JS dependencies.
1. Navigate to Administration > Extend and enable the module.
2. Navigate to Administration > Devportal > Configuration to manage
Devportal configurations.
- tamasd - https://www.drupal.org/u/tamasd
- Balazs Wittmann (balazswmann) - https://www.drupal.org/u/balazswmann
- lekob - https://www.drupal.org/u/lekob
Supporting organizations:
- Pronovix - https://www.drupal.org/pronovix