Articles

The road to trouble is paved with good intentions. In this article we talk about how to navigate the available solutions for developer portals while keeping an eye out for signs that will lead to dead ends. We explain the four most common developer portal anti-patterns that lead to a failure of your API program based on disuse, distrust, and exponential challenge.

In this article, we outline the basic principles of Docs-as-Code, some tools for writing and running automated tests against your documentation, and how these workflows can help improve the quality of your documentation. Using VS Code, git workflows, and automated documentation quality tests with Vale, we’ll show you how these tools can be used in concert in your DocOps setup.

Starting from an academic study, we explored further to outline the engagement attributes that go beyond usability by encouraging your user’s to play an active role in the success of your developer portal. We explain what engagement attributes are, how you can benefit, and give practical examples of how to implement them for your developer portal strategy.

In a sea of available options: What is Drupal Core, Drupal Modules, or a Drupal Distribution used for? What is the Apigee Edge Module and how is it related to Apigee Edge Integrated Portal or to Apigee Drupal KickStart? How do I get up and running with a devportal that uses Drupal 8?

When you create rules, procedures in an organization, that doesn't mean that people will actually follow those. People will use those rules and procedures as their environment inside of which they act. Whatever rule you set up, don't ever expect people to follow: you always have to look for the unintended consequences.

The goal of this article is to make you curious about:

1. Systems thinking
2. Complex Adaptive Systems
3. The role of APIs in Digital Transformation
4. The role of devportals in Digital Transformation

Why choose Drupal 8 for your developer portal? In this article we outline the elements of why Drupal 8 is a good candidate for building your developer portal and why we use it as the base for our SaaS product.

To choose a tool appropriate to your needs is to understand what functions it will serve. This article identifies the key reasons why you would choose a static site generator (SSG) or a content management system (CMS) for constructing your devportal.

The goal of the DevPortal Awards is to recognize the best developer portals and learn from their practices. In this post, we share the Q&A we did with the teams that made their portal an awarded success!

In our Devportal Design Guide series, you will read about common design patterns, get an insight into our project work related experiences, and learn how we tackle the design of a developer portal user interface.

Part 5: Further visual solutions to improve the user experience

In our Devportal Design Guide series, you will read about common design patterns, get an insight into our project work related experiences, and learn how we tackle the design of a developer portal user interface.

Part 4: Basic graphical elements that support functionality

What makes your API references good? How can you boost developer experience? What docs do decision makers need? What ensures accessibility?

A handful of leaders in the API space are developing DX innovations for their API products and developer portals, but it is difficult to see clear trends in the API docs space. With the DevPortal Awards, Pronovix aims at creating an opportunity to celebrate the best developer portals, their API documentation components and inclusive characteristics, so that the API industry as a whole can accelerate its own learning.

In our Devportal Design Guide series, you will read about common design patterns, get an insight into our project work related experiences, and learn how we tackle the design of a developer portal user interface.

Part 3: Overall design style