Apigee Developer Portal Workshop

March 3, 2016
London, UK

What is possible with a Drupal developer portal?

Apigee Edge’s Developer Portal is built in Drupal, that means that you could leverage the 10s of thousands of free community modules contributed to the Drupal project to extend your portal and to integrate it with thousands of popular third party technologies.

Join us for a free half-a-day workshop to get an overview of some of the most important extensions you could make to your developer portal. The workshop will be presented by Kristof Van Tomme, CEO/evangelist at Pronovix, a Drupal consultancy.

Pronovix has worked with the Apigee Edge Developer Portal to turn it into a central hub for developer communication. We will show you how you can aggregate and structure different types of documentation, code samples, and product information landing pages.

We will show how you could use faceted search to make it easier to discover content, and how Drupal’s SEO optimisation modules can maximise the traffic your keyword rich documentation content generates.

At the end of the workshop you will have learned how you can turn your developer portal into a documentation hub, that not only supports your developer evangelism but also helps you gain leads through technical content marketing.


Documentation can mean a lot of different things depending on the product and audience for which it is produced. As a result a lot of organisations have different documentation deliverables in different places and formats. This confuses customers and wastes valuable content marketing potential.

Today’s customers research products online even before they decide what providers they will contact. Having a consistent, well interlinked documentation that is part of your marketing automation infrastructure and that has unobtrusive call to actions to your marketing site, will help drive adoption of your services.

Separate and clearly label the documentation for different versions of your product.
Keywords or tags create a conceptual interlinked structure for your content that helps users discover related information.
Faceted search
Search facets enable users to narrow down search results using the version and keyword classification systems.

Consistent, visually appealing, and responsive landing pages

While it is possible to make custom designed HTML pages inside your portal, this can be an expensive and slow undertaking: the work of a designer, the content author, the front-end developer, and the back and forward between them can easily take weeks. If you quickly need a good looking page for an event, or want to A/B test landing pages for your services or products this might be a problem.

The page you are looking at was written and laid out in 1,5 day, with a more traditional approach this would take weeks.

The Paragraph module was developed to address this problem. We will demonstrate how it can be used to develop a branded library of content building blocks that helps you to easily and quickly build landing pages with a consistent look and feel. Once implemented, Paragraphs does not need the involvement of a designer or developer to build landing pages: an editor can choose the relevant content blocks and fill in a form to generate a page.

We’ll demonstrate the tool and share a content template that we developed based on the long form landing page format that is currently very popular in the startup community. We’ll also explain how you can use this module to embed call to actions that help you collect information from your visitors.

Third party integrations
Video solutions
A range of enterprise video solutions and the most popular video solutions have modules for Drupal.
A plethora of CRMs have integrations with Drupal. With different levels of integration for lead capture and account synchronisation.
Live chat
A surprising number live chat solutions have integrations with Drupal, you only need to install their module and configure it with account details to get started.
Email marketing
Different modules integrate with email services that help you build and manage your email lists.
Drupal obviously has integration with Google Analytics, but that is not the only analytics solution with an integration.
Marketing automation
Several solutions allow you to track who is visiting your developer portal, and what company they work for.

Authoring and publishing solutions

As one of the most popular open source Content Management Systems, Drupal has a broad range of authoring and publishing solutions.

Authoring & workflow
Depending on your organisation’s requirements content can be published after it has been reviewed and authorised by key stakeholders.
Automated imports
It is possible to configure automatic publishing workflows that trigger a build process when content is pushed to a code repository.
Supported formats
Content can be imported from most sources. Solutions exist to import content in a range of formats including Markdown, DITA, HTML, AsciiDoc, RST, Doxygen, Javadoc, etc.

Building a code sample library

No Developer Portal is complete without a code sample library. Code samples that are stored in code repositories can be really hard to find. A code sample library lets you organise your samples in a logical structure that makes them more accessible. It also lets you republish questions, answers and code samples from places like Stackoverflow into your documentation.

We’ve worked with code samples stored in GitLab before, and have developed a Drupal module that lets you link to and display GitLab files in a Drupal page. It also automatically generates a changelog of a project. The generated changelogs could be inserted into the site, or used to administrate code samples.

A similar code sample field could also be developed using the Drupal GitHub API module. Code samples can be postprocessed with the GeSHi filter module that can turn mentions of API functions into links to the documentation of those functions.

Community interaction

Community can make a product or service great and can enlist your users in support and documentation efforts. Drupal was written as community software, and modules like Organic Groups allow you to build practically any type of community portal you can imagine. Modules like User Points and it’s add-on modules can be used to implement gamification strategies.

Question & Answers
Answer questions from your users and make the answers available to all your customers.
Let your customers answer some of the questions other customers are asking.
Third party integration
Drupal has modules for a range of helpdesk solutions, including popular software like Zendesk, Kayako, or Freshdesk.

Optional topics and Showcases

As a participant you can send in specific questions that we can address during the workshop. Optionally we could for example also talk about Multilingual support, Search Engine Optimisation modules and Call to actions. If there is interest we can show a practical example of how we’ve Imported documentation content that was authored outside of Drupal in DITA. If there is time left we will also definitely talk about how we’ve built a Developer Portal for iText that helps them publish a code sample book from Stackoverflow to LeanPub using Drupal and GitLab.