Fediversity Panel

Feature Specification: Instances overview

Created: 2026-09-23

Status: Implemented

Input: Reconstructed from the code of panel/ at 0bf4ecd36, api/specification.md, pull requests #1548, #1892 and #1900, and the design notes of the maintainers.

User Scenarios & Testing (mandatory)

User Story 1 - See all my running services (Priority: P1)

The instances overview shows the instances of each deployment of the operator: the application instances and the supporting components, as api reports them. A card links to the address of an instance that is deployed, and shows the logo that api serves. A card has a "changed" tag when the section that configures the instance differs between the draft and the deployed configuration. A settings control on the card opens the form of that section.

Why this priority: the operator thinks in services, not in configurations.

Independent Test: unit tests of the overview.

Acceptance Scenarios:

  1. Given a deployed deployment, When the operator opens the overview, Then the page shows one card for each instance that api gives, with a link to its address.
  2. Given a deployment that is not deployed, When the operator opens the overview, Then the cards have no link, and no card has the tag.
  3. Given a deployment without instances, When the operator opens the overview, Then the page gives a hint and a link to the form.
  4. Given a draft that changes one section, When the operator opens the overview, Then only the card of that section has the tag.
  5. Given an instance with a section, When the operator uses its settings control, Then the form of that section opens. An instance without a section has no settings control.

Edge Cases

  • api does not answer for one deployment: only the group of that deployment shows a warning.
  • A logo is missing: the card shows a fallback image.

Requirements (mandatory)

Functional Requirements

  • FR-001: The panel MUST take the instances, their names, their state, their addresses, their sections and the changed sections from the typed answers of api, and MUST NOT read the configuration for them.
  • FR-002: The panel MUST call api once for each deployment, and MUST limit a failure to the group of that deployment.
  • FR-003: The panel MUST link only to instances that are deployed.

Key Entities

  • Instance: an application or a supporting component of a deployment, as api reports it.

Success Criteria (mandatory)

Measurable Outcomes

  • SC-001: The overview shows the correct instances without reading the configuration.

Assumptions

  • api derives the instances, their sections and the domain from the configuration.