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.

Sign up for GitHub

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

Rephrase What is Horreum? #2240

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Rephrase What is Horreum? #2240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,7 @@
---
## What is Horreum?

Horreum is a service for storing performance data and regression analysis.

Please, visit our project website:

[https://horreum.hyperfoil.io](https://horreum.hyperfoil.io)

for more information.

Horreum is a [Quarkus](https://quarkus.io/) based application which uses
[Quinoa](https://quarkiverse.github.io/quarkiverse-docs/quarkus-quinoa/dev/) as its [nodejs](https://nodejs.org/en) engine.
[Horreum](https://horreum.hyperfoil.io) is a web-based platform for storing, managing and visualizing the results of your performance experiment. It provides a user-friendly interface for monitoring the experiments, as well as for analyzing and visualizing the results. It also provides an automated way to detect performance anomaly. Horreum is designed to be scalable and can handle large amount of data, making it a popular choice for tracking performance regressions.
Copy link
Collaborator

@willr3 willr3 Jan 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and visualization

I do not think we should emphasize Horreum as a visualization tool. It has some charting capabilities but it is not positioned as a visualization tool like Grafana and Jupyter notebooks.

interface for monitoring the experiments

This section might need clarification. My first thought from this sentence is that Horreum would offer live monitoring of experiments but I do not believe Horreum has that feature.
Horreum is a repository for performance test results. It has anomaly detection which could be considered monitoring but that is not what first comes to mind when I read the initial sentence. I would also recommend we not use the word experiments unless you are referring to the experiments feature inside Horreum. There are a few keywords associated with Horreum (Test, Run, Label, ...) and it would likely help users if we try to keep consistent with those keywords.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @willr3

Thanks for your review. Would you like to rephrase my change with your changes in mind?


## Prerequisites

Expand Down
Loading