Skip to content

Geo: Add relevant links to the Single Replicable view

Release notes

The Admin > Geo > Replicables > Project Repositories > Details provides a link to the corresponding project view in the Admin Area for quick access to more context. Other Components display their own relevant links.

Problem to solve

Following up #509363 (closed), in which a sysadmin can view all of the data for one registry row.

When a sysadmin is troubleshooting a replication problem, any likely relevant information should be easily available. Otherwise, sysadmins are forced to do a lot more research and work, and they are more likely to need Support.

Proposal

With each type of Registry, provide an array of relevant, labeled links.

Example links for Package file:

  • View the Package which contains the Package File
  • View the Package registry documentation
  • View the Geo Troubleshooting docs: Missing files

Example links for Upload which is associated with a project:

  • View the project
  • View the upload file
  • View the Geo Troubleshooting docs: Orphaned upload records
  • View the Geo Troubleshooting docs: Missing files

Implementation Guide

  • Implement a generic Types::LinkType based on Types::Vulnerabilities::LinkType (although I would strongly prefer path over url since url is not compatible with multiple/separate external URLs)
  • Add links field to Geo::RegistryType: field :links, [::Types::LinkType], null: true, description: 'List of links associated with the replicable.'

This way, the backend is responsible for naming the link. And we can add as many useful links as we like.

Intended users

Feature Usage Metrics

We could track number of visits to the Single Replicable view.

Does this feature require an audit event?

No.

Edited by Michael Kozono