Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FE] Summary Text widget #138

Open
01painadam opened this issue Jan 31, 2025 · 0 comments
Open

[FE] Summary Text widget #138

01painadam opened this issue Jan 31, 2025 · 0 comments
Assignees

Comments

@01painadam
Copy link
Collaborator

01painadam commented Jan 31, 2025

Goal

Implement a portfolio summary widget that automatically generates:

  • A descriptive dashboard name based on the selected KBAs
  • A short portfolio summary including key statistics

The summary is static and cannot be edited, except when the KBAs in the portfolio change.

Designs

Example:

Amazon Rainforest Conservation Portfolio

This portfolio includes 12 Key Biodiversity Areas (KBAs) across Brazil and Peru, covering 520,000 hectares. These areas support jaguar (Panthera onca), giant river otter (Pteronura brasiliensis), and various endemic amphibians. The dominant habitat types include tropical moist forests and freshwater wetlands.

Generated Content

Dashboard Name

A name that reflects the portfolio’s focus e.g.

  • Amazon Rainforest Conservation Portfolio
  • West African Mangroves Monitoring
  • Key Biodiversity Areas in the Congo Basin

Portfolio Summary

A brief, auto-generated summary containing:

  • Number of KBAs in the portfolio
  • Total area covered
  • Locations and countries
  • Key species and habitats

Scope

In Scope

  • Automated generation of a dashboard name
  • Automated generation of a portfolio summary
  • Updates only when KBAs in the portfolio change

Out of Scope

  • No manual editing of the generated name or summary
  • No additional insights beyond key statistics

Job Stories & Acceptance Criteria

Generating a Dashboard Name and Summary

When I create or update my KBA portfolio,
I want to see a meaningful dashboard name and a short portfolio summary,
So that I can quickly understand the key characteristics of my selected KBAs.

Acceptance Criteria:

  • The system generates a name that reflects the KBAs in the portfolio
  • The summary includes the number of KBAs, total area, locations, and key species

Handling Portfolio Changes

When I add or remove KBAs from my portfolio,
I want to see the dashboard name and summary update accordingly,
So that they always reflect the latest portfolio selection.

Acceptance Criteria:

  • The dashboard name and summary update when the portfolio changes
  • Users cannot manually edit the generated text

Risks & Questions

  • how do we change the KBAs in a dashboard?

Solution Hints

  • Use structured templates to ensure consistency in name and summary generation
  • Prioritise geographic and ecological context for meaningful summaries
  • Ensure summaries are concise yet informative, without unnecessary detail

Future Work

...

@01painadam 01painadam added this to the Monitoring workflow milestone Jan 31, 2025
@01painadam 01painadam changed the title [FE] Summary Text component [FE] Summary Text widget Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants