Skip to content

Developer Portals for Platform Adoption: CNPA practice questions

A developer portal is the web interface where developers discover what the platform offers, start new projects, find documentation and see the state of the software they own. The CNCF Platforms White Paper lists web portals for observing and provisioning products and capabilities as the first of its capability domains and names Backstage as an example project.

By Ibrahim Yesilay · Published · Updated

Independent community practice, not affiliated with or endorsed by CNCF or The Linux Foundation.

What Developer Portals for Platform Adoption covers in CNPA

A developer portal is the web interface where developers discover what the platform offers, start new projects, find documentation and see the state of the software they own. The CNCF Platforms White Paper lists web portals for observing and provisioning products and capabilities as the first of its capability domains and names Backstage as an example project. Portals matter for adoption because a capability nobody can find is a capability nobody uses.

Backstage, a CNCF incubation project, is the reference implementation. Out of the box it combines three features. The Software Catalog keeps track of all software and its owners. Software Templates, found under /create, let a developer choose a template, fill in its inputs, review them and run a set of steps that load a code skeleton, fill in variables and publish the result to a location such as GitHub or GitLab, with the organization's practices already built in. TechDocs gives each component documentation written in Markdown next to its code, a docs-like-code approach, and shows it on the component's page in the catalog. A growing ecosystem of open source plugins brings other tools into the same view. Backstage's documentation frames the benefits per audience: engineering managers can maintain standards, developers get one place to build software and find documentation, and platform engineers get an extensible way to integrate new tools.

Adoption is where portals are most often misunderstood. The Platform Engineering Maturity Model describes adoption levels from Erratic, where teams discover tools through rumors and chance conversations, through Extrinsic push, where incentives or mandates drive use, to Intrinsic pull, where users choose platform capabilities for the value they bring, and finally Participatory, where users contribute fixes and new capabilities back. Self-serve portals, golden-path templates and good documentation are listed among the things that enable rapid use at the pull stage. A portal does not create pull by itself, though. If the processes behind its buttons are still manual tickets, it is just a nicer-looking queue.

Measuring adoption is part of the job. The white paper suggests tracking active users and retention, the number of capabilities provisioned and satisfaction surveys such as Net Promoter Score, and DORA's platform guidance recommends measuring how quickly new teams onboard and whether they keep using the platform. Platform teams can also drive adoption deliberately with announcements, engaging demos and regular feedback sessions, and by starting with a few engaged partner teams who later champion the platform to others.

Misconceptions to avoid: the portal is not the platform, only one of its interfaces; installing Backstage starts a product effort rather than finishing one, because the catalog and templates need ongoing curation; and pushing everyone onto the portal by decree tends to produce resistance rather than adoption.

Expect associate-level questions on what a portal provides, which Backstage feature fits a need such as scaffolding a service or publishing docs, and which signals show that adoption is healthy.

Key points

  • Backstage combines the Software Catalog, Software Templates, TechDocs and a plugin ecosystem.
  • Software Templates scaffold new components from code skeletons with the organization's defaults.
  • Adoption moves from erratic, to extrinsic push, to intrinsic pull, to participatory.
  • A portal is one interface of the platform; automation behind it is what makes it self-service.

Three sample questions

8 CNPA questions on Developer Portals for Platform Adoption, 8 with explanations. How practice works

Question 1

Which Backstage feature loads code skeletons, fills in variables and publishes the result to locations such as GitHub or GitLab, registering the new component in the catalog?
  1. A.The search plugin
  2. B.The Software Catalog
  3. C.Software Templates
  4. D.TechDocs

Correct answer: C

The Backstage docs describe Software Templates as a tool that helps create components: by default it can load skeletons of code, template in some variables and publish the template to locations like GitHub or GitLab. Software created through templates is automatically registered in the Software Catalog. Why the other options are wrong. "The search plugin": Search helps find software and docs; it does not create repositories. "The Software Catalog": The catalog tracks ownership and metadata of existing software; templates create new components. "TechDocs": TechDocs is Backstage's docs-like-code solution for Markdown documentation, not a project generator.

Sources: CNCF CNPA curriculum (CNPA_Curriculum.pdf), Backstage Software Templates, Backstage Software Catalog, Backstage: What is Backstage?

Question 2

After a good experience requesting a database from the internal platform, a team that later needs a queue checks the platform first and chooses its offering over the technology it had planned to use. Which Adoption level of the CNCF Platform Engineering Maturity Model does this illustrate?
  1. A.Level 2, Operationalized: extrinsic push
  2. B.Level 3, Scalable: intrinsic pull
  3. C.Level 4, Optimizing: participatory
  4. D.Level 1, Provisional: erratic

Correct answer: B

The maturity model's Adoption aspect uses this scenario for Level 3 (Scalable, intrinsic pull): users choose platform capabilities because of the value they provide, seek out further capabilities after a good experience, and prefer internal implementations over alternatives. Why the other options are wrong. "Level 2, Operationalized: extrinsic push": Extrinsic push relies on incentives or mandates rather than the value users see. "Level 4, Optimizing: participatory": Participatory adoption means users contribute fixes and new capabilities back to the platform. "Level 1, Provisional: erratic": Erratic adoption has no strategy, and teams find tools through rumours and chance conversations.

Sources: CNCF CNPA curriculum (CNPA_Curriculum.pdf), CNCF Platform Engineering Maturity Model

Question 3

Which statement describes Backstage according to its own documentation?
  1. A.An open source framework for developer portals, centred on a software catalog
  2. B.A hosted service that runs and scales the applications listed in its catalog
  3. C.A continuous delivery engine that syncs Git repositories to Kubernetes clusters
  4. D.A Kubernetes distribution that bundles a developer portal into the control plane

Correct answer: A

The Backstage documentation calls it an open source framework for building developer portals, powered by a centralized software catalog that restores order to microservices and infrastructure. Its built-in features include the Software Catalog, Software Templates and TechDocs, extended by plugins. Why the other options are wrong. "A hosted service that runs and scales ...": Backstage is a framework that organizations use to build their own portal; it tracks software, it does not run or scale it. "A continuous delivery engine that syncs Git ...": Syncing Git to clusters describes a GitOps delivery tool, not a developer portal framework. "A Kubernetes distribution that bundles a developer ...": Backstage is not a Kubernetes distribution and does not live in the cluster control plane.

Sources: CNCF CNPA curriculum (CNPA_Curriculum.pdf), Backstage: What is Backstage?

Practice this topic

Focus mode keeps every question on Developer Portals for Platform Adoption until you leave it. 10 free guest answers, then a free account; no credit card.

Or open CNPA practice across all topics.

Sources

The explanation above was checked against these official documents.